v1

latestOpenAPI 3.0.32026-07-24411867.5 KB

Update an entity

patch/entities/{entity_id}

Path parameters

entity_idinteger required

Request body

namestring
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
user_idinteger

The ID of the user (primary contact) for this entity.

entity_typestring

The type of entity (e.g., 'Individual', 'Corporation', 'Partnership', 'LLC').

business_emailstring email nullable

The business email address for this entity.

other_emailstring email nullable

An additional email address for this entity.

inactiveboolean nullable

Whether this entity is inactive.

Response

Entity updated

idinteger required
entity_typestring required
namestring required
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
tax_return_namestring required
created_atstring date-time required
upload_linkstring uri required
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring required