Examples

PATCH /api/v2/accounts/391/add-following-accounts
{
  "data": {
    "id": "391",
    "type": "accounts",
    "relationships": {
      "following-accounts": {
        "data": [
          {
            "type": "accounts",
            "id": 392
          },
          {
            "type": "accounts",
            "id": 393
          }
        ]
      }
    }
  }
}
200
{
  "data": {
    "id": "391",
    "type": "accounts",
    "links": {
      "self": "/api/v2/accounts/391"
    },
    "attributes": {
      "custom-footer": null,
      "name": "Shaina Runolfsson III",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/small/test.png?1513677232",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/medium/test.png?1513677232",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/large/test.png?1513677232",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/391/xlarge/test.png?1513677232"
      },
      "country": null,
      "joined-in-at": "2017-12-19T17:53:52.834+08:00",
      "title": null,
      "is-insight-provider": false,
      "is-client": true,
      "min-market-cap": null,
      "max-market-cap": null,
      "slug": "shaina-runolfsson-iii",
      "is-synthetic": false,
      "ip-rank": null,
      "funnel-status": null,
      "push-notification-setting": {
        "real-time-alert": true
      },
      "insight-provider-type": null,
      "client-type": "professional",
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "female",
      "has-changed-password": false,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "trial-end-date": null,
      "areas-of-expertise": null,
      "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": null,
      "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": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "total-unread-notifications": 0,
      "client-agreed-at": null,
      "intercom-hash": "d30c31a1faa38f8192277be0fdde55fd5234937ead601e7ba61f8fa47f274bde"
    },
    "relationships": {
      "company": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/company",
          "related": "/api/v2/accounts/391/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/account-lead",
          "related": "/api/v2/accounts/391/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introducer",
          "related": "/api/v2/accounts/391/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introducer-company",
          "related": "/api/v2/accounts/391/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/content-verticals",
          "related": "/api/v2/accounts/391/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/insights",
          "related": "/api/v2/accounts/391/insights"
        }
      },
      "entities": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/entities",
          "related": "/api/v2/accounts/391/entities"
        }
      },
      "countries": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/countries",
          "related": "/api/v2/accounts/391/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/sectors",
          "related": "/api/v2/accounts/391/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-accounts",
          "related": "/api/v2/accounts/391/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/premium-services",
          "related": "/api/v2/accounts/391/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-insight-providers",
          "related": "/api/v2/accounts/391/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-insights",
          "related": "/api/v2/accounts/391/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/introduced-trending-entities",
          "related": "/api/v2/accounts/391/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/filter-presets",
          "related": "/api/v2/accounts/391/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/external-reports",
          "related": "/api/v2/accounts/391/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/annotations",
          "related": "/api/v2/accounts/391/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/locker-items",
          "related": "/api/v2/accounts/391/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/muted-items",
          "related": "/api/v2/accounts/391/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/follows",
          "related": "/api/v2/accounts/391/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/following-accounts",
          "related": "/api/v2/accounts/391/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/push-notification-tokens",
          "related": "/api/v2/accounts/391/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/qva-reports",
          "related": "/api/v2/accounts/391/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/comments",
          "related": "/api/v2/accounts/391/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/shared-items",
          "related": "/api/v2/accounts/391/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "/api/v2/accounts/391/relationships/account-point",
          "related": "/api/v2/accounts/391/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.

data
required

Account information

Validations:

  • Must be a Hash

data[old-password]
optional

Required if changing password

Validations:

  • Must be a String

data[password]
optional

Required if changing password (new password to use)

Validations:

  • Must be a String

data[password-confirmation]
optional

Required if changing password (confirm new password to use)

Validations:

  • Must be a String

data[name]
optional

Account's name

Validations:

  • Must be a String

data[company-name]
optional

Account's company name

Validations:

  • Must be a String

data[city]
optional

Account's city

Validations:

  • Must be a String

data[country]
optional

Account's country

Validations:

  • Must be a String

data[title]
optional

Account's title/headline

Validations:

  • Must be a String

data[summary]
optional

Account's short description/mini biography

Validations:

  • Must be a String

data[education]
optional

Account's educational background

Validations:

  • Must be an array of any type

data[work-experience]
optional

Account's work experiences

Validations:

  • Must be an array of any type

data[skills]
optional

Account's skills/expertise (Insight Providers only)

Validations:

  • Must be an array of any type

data[country-mandates]
optional

Account's country mandates (Clients only)

Validations:

  • Must be an array of any type

data[sector-mandates]
optional

Account's sector mandates (Clients only)

Validations:

  • Must be an array of any type

data[accreditations]
optional

Account's professional accreditations (Clients only)

Validations:

  • Must be a Hash

data[jurisdiction]
optional

Account's country of jusrisdiction (Clients only)

Validations:

  • Must be a String

data[time-zone]
optional

Account's time zone (Clients only)

Validations:

  • Must be a String

data[communication-setting]
optional

Account's email communication settings

Validations:

  • Must be a Hash

data[communication-setting][reading-list-delivery]
optional

Account's reading list delivery (Clients only)

Validations:

  • Must be one of: daily, weekly, never.

data[communication-setting][real-time-alert]
optional

Account's real time email alerts (Clients only)

Validations:

  • Must be one of: true, false.

data[communication-setting][peer-review-frequency]
optional

Account's peer reviews frequency (Insight Providers only)

Validations:

  • Must be one of: daily, never.

data[profile-photo]
optional

Account's profile photo file in data URL format

Validations:

  • Must be a String

data[profile-photo-file-name]
optional

Account's profile photo file name

Validations:

  • Must be a String