SPsponsorunited
User

Update a user

Updates a user's profile information, roles, and organization details. Syncs changes to Intercom and Meilisearch

put/api/user/{id}

Request

Path parameters

idinteger required

Id of a user

Request body

namestring required
avatarstring
emailstring required
roleinteger required
person_profile_job_role_idinteger
job_titlestring
linkedin_urlstring
facebook_urlstring
twitter_urlstring
instagram_urlstring
is_externalboolean
force_new_passwordboolean
role_orientation_idinteger nullable

Id of a role orientation, as returned by GET /api/role-orientation (machine keys for reference: sell_side, buy_side, student, both). When omitted or null the user is assigned the default orientation (both).

Example request

{
  "role_orientation_id": 2
}

Response

The updated user

idinteger
emailstring
currencystring
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time
last_active_atstring date-time
is_externalboolean
verifiedinteger
genuineinteger
hubspot_idinteger
hubspot_synced_onstring date-time
force_new_passwordinteger
credentials_sent_atstring date-time

Example response

{
  "role_orientation": {
    "id": 1,
    "name": "sell_side",
    "label": "Sell-Side"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.