v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-173538121.5 KB
Contacts

Add a single contact to a contact list

post/v1/contact-lists/{contact_list_id}/contacts

Path parameters

contact_list_idinteger required

Request body

namestring required

Contact's full name.

phone_numberstring

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

phone_number_2string

Secondary phone number.

phone_number_3string

Tertiary phone number.

contact_infoobject

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

idinteger

Unique identifier.

namestring

Contact's name.

phone_numberstring

Primary phone number.

phone_number_2string

Secondary phone number.

phone_number_3string

Tertiary phone number.

contact_infoobject

Custom metadata JSON.

contact_list_idinteger

ID of the parent contact list.

created_atstring date-time
updated_atstring date-time