Skip to main content
POST
Add a single contact to a contact list

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Path Parameters

contact_list_id
integer
required

Body

application/json
name
string
required

Contact's full name.

Maximum string length: 255
phone_number
string

Primary phone number (E.164 format recommended, e.g. +14155551234).

phone_number_2
string

Secondary phone number.

phone_number_3
string

Tertiary phone number.

contact_info
object

Arbitrary JSON metadata for the contact. Use this to store custom fields like email, address, company, or any key-value data your bot or campaign needs (e.g. {"email": "john@example.com", "company": "Acme", "plan": "enterprise"}).

Response

Contact created

id
integer

Unique identifier.

name
string

Contact's name.

phone_number
string

Primary phone number.

phone_number_2
string

Secondary phone number.

phone_number_3
string

Tertiary phone number.

contact_info
object

Custom metadata JSON.

contact_list_id
integer

ID of the parent contact list.

created_at
string<date-time>
updated_at
string<date-time>