accounts

Update Account

Update an existing account. Supports partial updates.

Updatable fields:

  • Standard fields (title, description, address, accountType, isActive)
  • Contact information (primaryEmail, primaryPhone)
  • contacts: Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.
  • 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.

patch/accounts/{account_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/accounts/{account_id}
  • Auth: API key in header x-api-key

Path parameters

account_idinteger required

Account identifier

Query parameters

allow_new_optionsboolean

Whether to allow creation of new dropdown options during record creation

Request body

titlestring

Account name

descriptionstring nullable

Account description

addressstring[]

An array containing a single string, which represents the primary account location/address.

accountType'RESIDENTIAL' | 'COMMERCIAL'

Account type

ownerIdinteger nullable

ID of the owning user

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

contactsinteger[] nullable

Contact IDs to associate with this account. The contacts must be created first via POST /contacts. The first ID in the array is treated as the primary contact.

isActiveboolean

Whether the account is active

customobject

Custom fields

Response

Account updated successfully

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Timestamp of the most recent update to the record, including changes to its custom property values.

titlestring

Record title/name

descriptionstring nullable

Record description

addressstring[]

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

numberinteger

Record number (e.g., 1234)

customobject

Custom fields

accountType'RESIDENTIAL' | 'COMMERCIAL'

Type of account (residential or commercial)

Changes

No recorded changes to this operation across all 1 revision of this API.