Update Account

Update an existing account. Supports partial updates. Updatable fields: - Standard fields (value, size, type, etc.) - Contact information (primaryEmail, primaryPhone) - Custom fields (through custom object) Note: Updates are atomic - either all fields update or none do. **Note:** The `/clients` path is an alias for `/accounts` and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

accountIdstringRequired
Account identifier

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.
accountTypeenum or nullOptional

Type of account (residential or commercial)

Allowed values:
addresslist of stringsOptional

Record location/address

contactslist of objectsOptional
createdAtstringOptionalformat: "date-time"
Creation timestamp
custommap from strings to anyOptional
Custom fields
descriptionstring or nullOptional
Record description
idintegerOptional
Unique identifier
isActivebooleanOptional
Whether the record is active
numberintegerOptional

Record number (e.g., 1234)

primaryEmailstring or nullOptionalformat: "email"
Primary contact email
primaryPhonestring or nullOptional
Primary contact phone
titlestringOptional

Record title/name

updatedAtstringOptionalformat: "date-time"
Last update timestamp

Response

Account updated successfully
accountTypeenum or null

Type of account (residential or commercial)

Allowed values:
addresslist of strings or null

Record location/address

contactslist of objects or null
createdAtstring or nullformat: "date-time"
Creation timestamp
custommap from strings to any or null
Custom fields
descriptionstring or null
Record description
idinteger or null
Unique identifier
isActiveboolean or null
Whether the record is active
numberinteger or null

Record number (e.g., 1234)

primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
titlestring or null

Record title/name

updatedAtstring or nullformat: "date-time"
Last update timestamp

Errors