accounts

Create Account

Create a new account with required and optional fields.

Required fields:

  • title: Account name
  • address: Account location

Optional fields:

  • accountType: Account type (RESIDENTIAL/COMMERCIAL)
  • value: Account value
  • size: Account size
  • primaryEmail/primaryPhone: Contact information
  • contacts: Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.
  • custom: Custom fields object

Note: If primaryEmail or primaryPhone is provided and no contacts are provided, a contact will be automatically created or matched.

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

post/accounts

Request

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

Query parameters

allow_new_optionsboolean

Whether to allow creation of new dropdown options during record creation

match_by'title' | 'primaryEmail' | 'primaryPhone' | 'address'

Field to use for matching existing records

match_found_strategy'skip' | 'replace' | 'enrich'
  • skip: Return existing record without changes
  • replace: Replace existing record with new data
  • enrich: Update only empty fields in existing record

Strategy to use when a match is found

Request body

titlestring required

Account name

descriptionstring nullable

Account description

addressstring[] required

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

Primary contact email

primaryPhonestring

Primary contact phone

contactsinteger[] nullable

Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts. The first ID in the array is treated as the primary contact.

customobject

Custom fields

Response

Matching account found

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.