Examples

PATCH /api/v2/accounts/347/follow
{}
200
{
  "data": {
    "id": "347",
    "type": "accounts",
    "links": {
      "self": "/api/v2/accounts/347"
    },
    "attributes": {
      "custom-footer": null,
      "name": "Maximus Jackson",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/small/test.png?1513677220",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/medium/test.png?1513677220",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/large/test.png?1513677220",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/347/xlarge/test.png?1513677220"
      },
      "country": null,
      "joined-in-at": "2017-12-19T17:53:40.415+08:00",
      "title": null,
      "is-insight-provider": true,
      "is-client": false,
      "min-market-cap": null,
      "max-market-cap": null,
      "slug": "maximus-jackson",
      "is-synthetic": false,
      "ip-rank": null,
      "funnel-status": null,
      "push-notification-setting": null,
      "insight-provider-type": "external",
      "client-type": null,
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "male",
      "has-changed-password": null,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "trial-end-date": null,
      "areas-of-expertise": {
        "industry-group-primary": null,
        "industry-group-secondary": null,
        "industry-primary": null,
        "industry-secondary": null,
        "market-caps": "Any",
        "sector-generalist": true,
        "country-generalist": true,
        "asset-class-primary": "Equities",
        "content-vertical-generalist": true
      },
      "activated": true,
      "is-compliance-officer": false,
      "has-distribution-restriction": false,
      "jurisdictions": [],
      "disclaimer": null,
      "team-leader": false,
      "is-introducer": false,
      "is-introducer-leader": false,
      "offer-premium-services": false,
      "premium-services-rate": null,
      "total-watched-entities": 0,
      "total-followed-insight-providers": 0,
      "total-alerts": 0,
      "last-active-at": null,
      "total-activities": 0,
      "is-followed": true,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "total-unread-notifications": null,
      "client-agreed-at": null,
      "intercom-hash": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/company",
          "related": "/api/v2/accounts/347/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/account-lead",
          "related": "/api/v2/accounts/347/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introducer",
          "related": "/api/v2/accounts/347/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introducer-company",
          "related": "/api/v2/accounts/347/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/content-verticals",
          "related": "/api/v2/accounts/347/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/insights",
          "related": "/api/v2/accounts/347/insights"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/entities",
          "related": "/api/v2/accounts/347/entities"
        }
      },
      "countries": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/countries",
          "related": "/api/v2/accounts/347/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/sectors",
          "related": "/api/v2/accounts/347/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-accounts",
          "related": "/api/v2/accounts/347/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/premium-services",
          "related": "/api/v2/accounts/347/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-insight-providers",
          "related": "/api/v2/accounts/347/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-insights",
          "related": "/api/v2/accounts/347/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/introduced-trending-entities",
          "related": "/api/v2/accounts/347/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/filter-presets",
          "related": "/api/v2/accounts/347/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/external-reports",
          "related": "/api/v2/accounts/347/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/annotations",
          "related": "/api/v2/accounts/347/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/locker-items",
          "related": "/api/v2/accounts/347/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/muted-items",
          "related": "/api/v2/accounts/347/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/follows",
          "related": "/api/v2/accounts/347/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/following-accounts",
          "related": "/api/v2/accounts/347/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/push-notification-tokens",
          "related": "/api/v2/accounts/347/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/qva-reports",
          "related": "/api/v2/accounts/347/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/comments",
          "related": "/api/v2/accounts/347/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/shared-items",
          "related": "/api/v2/accounts/347/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "/api/v2/accounts/347/relationships/account-point",
          "related": "/api/v2/accounts/347/account-point"
        }
      }
    }
  }
}

Params

Param name Description
id
required

account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.