SOsoraban
Entities

Update an entity

Updates entity details.

tag_ids replaces the entity's whole tag set: any existing tag not listed is removed. The ids must already belong to this entity, so create tags first with POST /entities/{entity_id}/tags.

patch/entities/{id}

Request

Request body

namestring
external_entity_idstring
streetstring
citystring
statestring
zipstring
countrystring
user_idinteger

Reassign the entity to another client. Must be a client, not an advisor.

entity_typestring
business_emailstring email
other_emailstring email
inactiveboolean
tag_idsinteger[]

Replaces the entity's tags. Tags not listed here are deleted.

Response

The updated entity.

idinteger
entity_typestring nullable
namestring nullable
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
inactiveboolean nullable
created_atstring date-time
upload_linkstring nullable
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring nullable
firm_role_summarystring

A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use GET /entities/{entity_id}/firm_role_assignments if you need the underlying ids.

firm_group_idinteger nullable
firm_groupobject nullable

Example response

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

Changes

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