API OverviewAPI EndpointsEntities

Update an entity

Updates an existing entity's details

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
ID of the entity to update

Request

This endpoint expects an object.
externalIdstringOptional
External identifier for the entity
legalNamestringOptional
Legal name of the entity
tinstringOptional
Tax Identification Number
usStatestringOptional
US state code
entityTypestringOptional
Type of entity
phoneNumberstringOptional
Contact phone number
statusstringOptional
Current status of the entity

Response

Entity updated successfully
idstring or null
Unique identifier of the updated entity
externalIdstring or null
External identifier for the entity
legalNamestring or null
Updated legal name
tinstring or null
Updated Tax Identification Number
usStatestring or null
Updated US state code
entityTypestring or null
Updated entity type
phoneNumberstring or null
Updated phone number
statusstring or null
Updated status
updatedAtdatetime or null
When the entity was last updated

Errors