Skip to main content
POST
Create a contact

Authorizations

Authorization
string
header
required

An API key from Settings > API keys. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:write, webhooks:manage.

Headers

Idempotency-Key
string

A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.

Maximum string length: 255

Body

application/json
name
string
Required string length: 1 - 200
phone
string

Phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
email
string<email>
Maximum string length: 320
locale
enum<string>
Available options:
en,
fr
timezone
string
Required string length: 1 - 80

Response

Created

data
object
required