Update Account | Coperniq API

const url = 'https://api.coperniq.io/v1/accounts/1';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "title": "string",
  "description": "string",
  "address": [
    "string"
  ],
  "isActive": true,
  "primaryEmail": "string",
  "primaryPhone": "string",
  "number": 1,
  "custom": {},
  "accountType": "RESIDENTIAL",
  "contacts": [
    {
      "id": 1,
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ]
    }
  ]
}

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.

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

accountIdintegerRequired

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.

titlestringOptional

Account name

descriptionstring or nullOptional

Account description

addresslist of stringsOptional

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

accountTypeenum or nullOptional

Account type

primaryEmailstring or nullOptionalformat: "email"

Primary contact email

primaryPhonestring or nullOptional

Primary contact phone

contactslist of integers or nullOptional

Contact IDs to associate with this account. The contacts must be created first via POST /contacts.

isActivebooleanOptional

Whether the account is active

custommap from strings to anyOptional

Custom fields

Response

Account updated successfully

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Record number (e.g., 1234)

custommap from strings to any

Custom fields

accountTypeenum or null

Type of account (residential or commercial)

contactslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error