Skip to main content
POST
/
v1
/
contact-lists
/
{contact_list_id}
/
contacts
Add a single contact to a contact list
curl --request POST \
  --url https://api.openmic.ai/v1/contact-lists/{contact_list_id}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "phone_number": "<string>",
  "phone_number_2": "<string>",
  "phone_number_3": "<string>",
  "contact_info": {}
}
'
{
  "id": 123,
  "name": "<string>",
  "phone_number": "<string>",
  "phone_number_2": "<string>",
  "phone_number_3": "<string>",
  "contact_info": {},
  "contact_list_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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": "[email protected]", "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>