SMS Contacts

Manage SMS contact lists with custom fields support.

WARNING

SMS Live Mode Only: All SMS endpoints require a live mode API key (sk_live_*).

Create Contact

Create a new SMS contact.

Endpoint: POST /v1/sms/contacts

Authentication: Required

Request Body:

Field	Type	Required	Description
`phone_number`	string	Yes	Phone number in E.164 format
`first_name`	string	No	Contact first name
`last_name`	string	No	Contact last name
`email`	string	No	Contact email
`custom_fields`	object	No	Custom field key-value pairs

Example:

HTTP

TypeScript

Python

Success Response (201):

{
  "data": {
    "id": "con_abc123",
    "phone_number": "+2207654321",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "custom_fields": {},
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Get Contact

Get details of a specific contact.

Endpoint: GET /v1/sms/contacts/{id}

Authentication: Required

List Contacts

Get a paginated list of contacts.

Endpoint: GET /v1/sms/contacts

Authentication: Required

Query Parameters:

Parameter	Type	Required	Description
`offset`	integer	No	Number of items to skip (default: 0)
`limit`	integer	No	Maximum number of items to return (default: 20, max: 100)
`group_id`	string	No	Filter by contact group ID

Update Contact

Update an existing contact.

Endpoint: PUT /v1/sms/contacts/{id}

Authentication: Required

Delete Contact

Delete a contact.

Endpoint: DELETE /v1/sms/contacts/{id}

Authentication: Required

Success Response (204): No content

SMS Contacts

Create Contact#

Get Contact#

List Contacts#

Update Contact#

Delete Contact#

Create Contact

Get Contact

List Contacts

Update Contact

Delete Contact