Create a contact | Hams AI Docs

Creates a contact. email, phone_number and identifier are each unique within the account, so a value already in use fails with 422.

Authentication

api_access_tokenstring

An API key created in Settings > Developer. A user token works too and is useful while you experiment. A key is authorized at the account level: it reaches every inbox, conversation and contact in the account that issued it, and nothing outside that account.

Path parameters

account_idintegerRequired

Your account id.

Request

This endpoint expects an object.

namestringOptional

emailstringOptionalformat: "email"

phone_numberstringOptionalformat: "^\+[1-9]\d{1,14}$"

identifierstringOptional

custom_attributesmap from strings to anyOptional

additional_attributesmap from strings to anyOptional

Response

The created contact.

payloadobjectOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

$	curl -X POST https://omni-channel.hams.ai/api/v1/accounts/1/developer/contacts \
>	-H "api_access_token: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"payload": {
3	"id": 1,
4	"name": "string",
5	"email": "string",
6	"phone_number": "string",
7	"identifier": "string",
8	"thumbnail": "string",
9	"custom_attributes": {},
10	"additional_attributes": {}
11	}
12	}