Contacts
The people behind leads: one person, one record, however many enquiries.
GET/contacts
List contacts
Needs the permission contacts:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
q | query | string | up to 100 characters |
ownerId | query | string (uuid) | |
tag | query | string | up to 40 characters |
sort | query | one of created, updated, name | default "created" |
order | query | one of asc, desc | default "desc" |
curl -X GET https://crm.anibrosdesign.com/api/v1/contacts \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/contacts
Create a contact
Needs the permission contacts:create.
| Parameter | In | Type | Notes |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string up to 128 characters. Repeating the request with the same key returns the first response. up to 128 characters |
| Body field | Type | Notes |
|---|---|---|
firstName required | string | at least 1 characters. up to 100 characters |
lastName | string or null | |
email | string or null | |
phone | string or null | |
alternateEmails | list of string | up to 5 items |
alternatePhones | list of string | up to 5 items |
company | string or null | |
jobTitle | string or null | |
city | string or null | |
ownerId | string (uuid) or null | |
tags | list of string | up to 30 items |
customFields | object of any |
curl -X POST https://crm.anibrosdesign.com/api/v1/contacts \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"firstName":"text","lastName":"text","email":"text"}'Responses:
201 400 401 402 403 429
GET/contacts/lookup
Get lookup (contacts)
Needs the permission contacts:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
email | query | string | up to 254 characters |
phone | query | string | up to 40 characters |
curl -X GET https://crm.anibrosdesign.com/api/v1/contacts/lookup \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
POST/contacts/merges/{id}/undo
Undo (contacts)
Needs the permission contacts:merge.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/contacts/merges/{id}/undo \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
GET/contacts/{id}
Get a contact
Needs the permission contacts:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/contacts/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
PATCH/contacts/{id}
Change a contact
Needs the permission contacts:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
firstName | string | at least 1 characters. up to 100 characters |
lastName | string or null | |
email | string or null | |
phone | string or null | |
alternateEmails | list of string | up to 5 items |
alternatePhones | list of string | up to 5 items |
company | string or null | |
jobTitle | string or null | |
city | string or null | |
ownerId | string (uuid) or null | |
tags | list of string | up to 30 items |
customFields | object of any |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/contacts/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"firstName":"text","lastName":"text","email":"text"}'Responses:
200 400 401 402 403 404 412 429
DELETE/contacts/{id}
Delete a contact
Needs the permission contacts:delete.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X DELETE https://crm.anibrosdesign.com/api/v1/contacts/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
204 400 401 402 403 404 429
GET/contacts/{id}/consents
Get consents (contacts)
Needs the permission contacts:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/contacts/{id}/consents \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/contacts/{id}/consents
Consents (contacts)
Needs the permission contacts:update.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
channel required | one of email, sms, whatsapp, push, phone_call | |
action required | one of grant, revoke | |
source | string | up to 40 characters. default "manual" |
legalBasis | one of consent, legitimate_interest, contract | |
proofUrl | string (uri) or null | |
reason | string or null | |
expiresAt | string (date-time) or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/contacts/{id}/consents \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"channel":"email","action":"grant","source":"manual"}'Responses:
200 400 401 402 403 404 429
POST/contacts/{id}/merge
Merge (contacts)
Needs the permission contacts:merge.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
duplicateIds required | list of string (uuid) | at least 1 items. up to 5 items |
curl -X POST https://crm.anibrosdesign.com/api/v1/contacts/{id}/merge \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"duplicateIds":["01a15d23-0000-7000-8000-000000000000"]}'Responses:
200 400 401 402 403 404 429
POST/contacts/{id}/restore
Restore (contacts)
Needs the permission contacts:delete.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/contacts/{id}/restore \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
Something missing or unclear? Tell us.