Create Account | Coperniq API

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.

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.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

allow_new_optionsbooleanOptionalDefaults to false

Whether to allow creation of new dropdown options during record creation

match_byenumOptionalDefaults to title

Field to use for matching existing records

Allowed values:

match_found_strategyenumOptionalDefaults to skip

Strategy to use when a match is found

Allowed values:

Request

This endpoint expects an object.

titlestringRequired

Account name

addresslist of stringsRequired

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

descriptionstring or nullOptional

Account description

accountTypeenumOptional

Account type

Allowed values:

primaryEmailstringOptionalformat: "email"

Primary contact email

primaryPhonestringOptional

Primary contact phone

contactslist of integers or nullOptional

Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.

custommap from strings to anyOptional

Custom fields

Response

Matching account found

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

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.

1	const url = 'https://api.coperniq.io/v1/accounts';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"title":"string","address":["1600 Pennsylvania Ave NW, Washington, DC 20500"]}'
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	}