Entity users

Attach a user to an entity

Changed on Nov 3, 2026

Adds a client user as an owner of the entity.

If email already belongs to a client of this firm, that client is attached and the response is 200. Otherwise a new client is created and attached, and the response is 201 — in that case fname and lname are required.

post/entities/{entity_id}/users

Request

Base URL
https://api.soraban.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soraban/apis/soraban-private-api/docs/entities/:entity_id/users/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

emailstring email required

fnamestring

Required when creating a new user.

lnamestring

Required when creating a new user.

assigned_advisor_idinteger

Required when creating a new user, unless the firm is on the newer contact management model, which rejects this parameter.

phone_numberstring

work_phone_numberstring

work_phone_extensionstring

preferred_contact_methodstring

time_zonestring

external_user_idstring

Response

An existing client was attached to the entity.

Example response

{
  "entity": {
    "firm_role_summary": "Partner: Jane Doe, Manager: John Smith"
  }
}

Changes

Nov 3, 20261c230fa547ad Revision changes
- breaking
  added the new required request property
- breaking
  request body became required
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property /// became nullable for the status
- breaking
  the response property /// became nullable for the status
- breaking
  the response property /// became nullable for the status
- breaking
  the response property /// became nullable for the status
- breaking
  the response property /// became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the / response's property type changed from string to string null, and format from no format to date-time for status
- breaking
  the //// response's property type changed from string to integer null for status
- breaking
  the ///// response's property type changed from string to integer for status
- warning
  deleted the path request parameter entity_id
- warning
  removed the optional property / from the response with the status
- info
  api operation id post_entities-entity-id-users removed and replaced with createEntityUser
- info
  api tag Entity users added
- info
  the request property became optional
- info
  the request property became optional
- info
  the request property became optional
- info
  removed the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the success response with the status

Operation history