Examples

PATCH /api/v2/accounts/394
{
  "data": {
    "id": "394",
    "type": "accounts",
    "attributes": {
      "name": "Rubye Beier I",
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/small/test.png?1513677233",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/medium/test.png?1513677233",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/large/test.png?1513677233",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/xlarge/test.png?1513677233"
      },
      "title": "The Boss",
      "company-name": null,
      "country": null,
      "slug": "rubye-beier-i",
      "joined-in-at": "2017-12-19 17:53:53 +0800",
      "is-insight-provider": false,
      "is-client": true,
      "is-synthetic": false,
      "areas-of-expertise": null,
      "communication-setting": {
        "email-insight-comment": true
      }
    },
    "relationships": {}
  }
}
200
{
  "data": {
    "id": "394",
    "type": "accounts",
    "links": {
      "self": "http://test.host/api/v2/accounts/394"
    },
    "attributes": {
      "publication-setting": null,
      "custom-footer": null,
      "name": "Rubye Beier I",
      "email": "49favian@runolfonleuschke.co",
      "company-name": null,
      "avatar-url": {
        "small": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/small/test.png?1513677233",
        "medium": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/medium/test.png?1513677233",
        "large": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/large/test.png?1513677233",
        "xlarge": "https://static-dev.smartkarma.com/accounts/profile_photos/000/000/394/xlarge/test.png?1513677233"
      },
      "city": null,
      "country": null,
      "joined-in-at": "2017-12-19T17:53:53.663+08:00",
      "title": "The Boss",
      "education": [],
      "work-experience": [],
      "skills": [],
      "is-insight-provider": false,
      "is-client": true,
      "linked-in": null,
      "twitter": null,
      "website": null,
      "country-mandates": [
        "Singapore"
      ],
      "sector-mandates": [
        "Energy"
      ],
      "min-market-cap": null,
      "max-market-cap": null,
      "accreditations": {
        "professional-accredited-investor": "false"
      },
      "jurisdiction": "Singapore",
      "slug": "rubye-beier-i",
      "is-synthetic": false,
      "time-zone": "Asia-Pacific",
      "summary": "Aliquid accusamus voluptates architecto. Nihil eius sed iusto accusamus omnis dolores dolorem. Et tempore aut laboriosam voluptates consequatur non quis.",
      "vertical-subscriptions": [
        "Baby & Movies 49"
      ],
      "ip-rank": null,
      "funnel-status": null,
      "communication-setting": {
        "private-message": true,
        "email-insight-comment": true,
        "email-insight-author": true,
        "email-comment-activity": true,
        "group-chat": true,
        "email-mention": true,
        "receive-alerts": true
      },
      "push-notification-setting": {
        "real-time-alert": true
      },
      "insight-provider-type": null,
      "client-type": "professional",
      "is-dormant": false,
      "short-name": "Jerry",
      "gender": "plural",
      "has-changed-password": false,
      "mobile": null,
      "landline": null,
      "team-size": null,
      "interface-setting": {},
      "trial-end-date": null,
      "notifications-read-at": "2017-12-19T17:53:53.663+08:00",
      "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,
      "is-followed": false,
      "introduced-total-follows": 0,
      "compliance": null,
      "compliance-download-link": null,
      "is-muted": false,
      "expiring-insights-count": 0,
      "total-unread-message-groups": 0,
      "published-insights-count": 0,
      "followers-count": 0,
      "insight-views-count": 0,
      "unsubmitted-insights-count": 0,
      "under-review-insights-count": 0,
      "press-access-agreed-at": null,
      "total-unread-notifications": 0,
      "client-agreed-at": null,
      "published-external-reports-count": 0,
      "external-report-views-count": 0,
      "intercom-hash": "f2c8f75b318eec8e6ba3acfb95ef23c0097de0c7b4b5dbeb3af0ca473f141be1"
    },
    "relationships": {
      "company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/company",
          "related": "http://test.host/api/v2/accounts/394/company"
        }
      },
      "account-lead": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/account-lead",
          "related": "http://test.host/api/v2/accounts/394/account-lead"
        }
      },
      "introducer": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introducer",
          "related": "http://test.host/api/v2/accounts/394/introducer"
        }
      },
      "introducer-company": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introducer-company",
          "related": "http://test.host/api/v2/accounts/394/introducer-company"
        }
      },
      "content-verticals": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/content-verticals",
          "related": "http://test.host/api/v2/accounts/394/content-verticals"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/insights",
          "related": "http://test.host/api/v2/accounts/394/insights"
        }
      },
      "entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/entities",
          "related": "http://test.host/api/v2/accounts/394/entities"
        }
      },
      "countries": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/countries",
          "related": "http://test.host/api/v2/accounts/394/countries"
        }
      },
      "sectors": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/sectors",
          "related": "http://test.host/api/v2/accounts/394/sectors"
        }
      },
      "introduced-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-accounts",
          "related": "http://test.host/api/v2/accounts/394/introduced-accounts"
        }
      },
      "premium-services": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/premium-services",
          "related": "http://test.host/api/v2/accounts/394/premium-services"
        }
      },
      "introduced-trending-insight-providers": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-insight-providers",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-insight-providers"
        }
      },
      "introduced-trending-insights": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-insights",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-insights"
        }
      },
      "introduced-trending-entities": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/introduced-trending-entities",
          "related": "http://test.host/api/v2/accounts/394/introduced-trending-entities"
        }
      },
      "filter-presets": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/filter-presets",
          "related": "http://test.host/api/v2/accounts/394/filter-presets"
        }
      },
      "external-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/external-reports",
          "related": "http://test.host/api/v2/accounts/394/external-reports"
        }
      },
      "annotations": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/annotations",
          "related": "http://test.host/api/v2/accounts/394/annotations"
        }
      },
      "locker-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/locker-items",
          "related": "http://test.host/api/v2/accounts/394/locker-items"
        }
      },
      "muted-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/muted-items",
          "related": "http://test.host/api/v2/accounts/394/muted-items"
        }
      },
      "follows": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/follows",
          "related": "http://test.host/api/v2/accounts/394/follows"
        }
      },
      "following-accounts": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/following-accounts",
          "related": "http://test.host/api/v2/accounts/394/following-accounts"
        }
      },
      "push-notification-tokens": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/push-notification-tokens",
          "related": "http://test.host/api/v2/accounts/394/push-notification-tokens"
        }
      },
      "qva-reports": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/qva-reports",
          "related": "http://test.host/api/v2/accounts/394/qva-reports"
        }
      },
      "comments": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/comments",
          "related": "http://test.host/api/v2/accounts/394/comments"
        }
      },
      "shared-items": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/shared-items",
          "related": "http://test.host/api/v2/accounts/394/shared-items"
        }
      },
      "account-point": {
        "links": {
          "self": "http://test.host/api/v2/accounts/394/relationships/account-point",
          "related": "http://test.host/api/v2/accounts/394/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