Update Account | Coperniq API

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.

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

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.

idintegerOptional

Unique identifier

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

titlestringOptional

Record title/name

descriptionstring or nullOptional

Record description

addresslist of stringsOptional

Record location/address

isActivebooleanOptional

Whether the record is active

primaryEmailstring or nullOptionalformat: "email"

Primary contact email

primaryPhonestring or nullOptional

Primary contact phone

numberintegerOptional

Record number (e.g., 1234)

custommap from strings to anyOptional

Custom fields

accountTypeenum or nullOptional

Type of account (residential or commercial)

Allowed values:

contactslist of objectsOptional

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)

Allowed values:

contactslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/accounts/1';
2	const options = {
3	method: 'PATCH',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"title": "string",
6	"description": "string",
7	"address": [
8	"string"
9	],
10	"isActive": true,
11	"primaryEmail": "string",
12	"primaryPhone": "string",
13	"number": 1,
14	"custom": {},
15	"accountType": "RESIDENTIAL",
16	"contacts": [
17	{
18	"id": 1,
19	"emails": [
20	"string"
21	],
22	"phones": [
23	"string"
24	]
25	}
26	]
27	}