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
accountId
Account identifier
Query parameters
allow_new_options
Whether to allow creation of new dropdown options during record creation
Request
This endpoint expects an object.
accountType
Type of account (residential or commercial)
Allowed values:
address
Record location/address
contacts
createdAt
Creation timestamp
custom
Custom fields
description
Record description
id
Unique identifier
isActive
Whether the record is active
number
Record number (e.g., 1234)
primaryEmail
Primary contact email
primaryPhone
Primary contact phone
title
Record title/name
updatedAt
Last update timestamp
Response
Account updated successfully
accountType
Type of account (residential or commercial)
Allowed values:
address
Record location/address
contacts
createdAt
Creation timestamp
custom
Custom fields
description
Record description
id
Unique identifier
isActive
Whether the record is active
number
Record number (e.g., 1234)
primaryEmail
Primary contact email
primaryPhone
Primary contact phone
title
Record title/name
updatedAt
Last update timestamp
