Skip to main content
POST

Authorizations

Authorization
string
header
required

Personal Access Token (PAT) is a Bearer token used for secure API calls. For direct API calls, the PAT is used in the Authorization header as 'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client settings (e.g., in your IDE's MCP server configuration) - authentication will be handled automatically.

Body

application/json
name
string
required

Contact name

Maximum string length: 100
Example:

"John Doe"

fax_number
string
required

Contact's fax number

Required string length: 2 - 20
Pattern: ^\+[0-9]{1,15}$
Example:

"+12025551234"

email
string

Contact's email address

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$
Example:

"john.doe@example.com"

cellphone
string

Contact's cellphone number

Maximum string length: 20
Pattern: ^$|^[+]?[0-9]*$
Example:

"+12025551235"

phone
string

Contact's phone number

Maximum string length: 20
Pattern: ^$|^[+]?[0-9]*$
Example:

"+12025551236"

notes
string

Additional notes

Maximum string length: 1000
Example:

"Prefers email communication"

groups
string[]

List of group names

Maximum array length: 50
Maximum string length: 100
Example:
is_telefax
boolean

Whether this contact has a human fax operator. When enabled, an IVR will ask the operator to switch to fax mode

Example:

false

shared
boolean

Whether to share contact with corporate members

Example:

false

Response

Contact created successfully