Insert

post

https://{host}/v2/contact-lists/{contactListId}/contacts

Adds a new contact to the specified contact list.

If you are using the Organisation Hierarchy feature, to assign a contact to an entity within the hierarchy, supply either entity_id or entity_unique_id (not both); the entity must be active and belong to your organisation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contactListId

int32

required

The contact list whose contacts you are querying

Body Params

Request DTO for adding a new contact to a contact list

name

string

required

length between 0 and 250

The display name for the contact

string | null

^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

The email for this contact, if an email contact list

mobile

string | null

^[0-9]*$

The mobile number for this contact containing only digits

custom_columns

array of objects | null

Custom columns for this contact, if relevant to the contact list

custom_columns

entity_id

int32 | null

The numeric id of the entity to assign to this contact. Supply either this or
entity_unique_id, not both; omit both to leave the contact unassigned.
The entity must be active and belong to your organisation.

entity_unique_id

string | null

The customer-facing unique code of the entity to assign to this contact. Supply either this or
entity_id, not both; omit both to leave the contact unassigned.
The entity must be active and belong to your organisation.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Success

400Request validation errors or international number not permitted

403Forbidden

404Contact List not found