Create or add contacts to list
curl --request POST \
--url https://api.voxworks.ai/api/v1/lists/{list_id}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contacts": [
{
"phone_number": "0429069971",
"first_name": "John",
"last_name": "Smith"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contacts: [{phone_number: '0429069971', first_name: 'John', last_name: 'Smith'}]
})
};
fetch('https://api.voxworks.ai/api/v1/lists/{list_id}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voxworks.ai/api/v1/lists/{list_id}/contacts"
payload = { "contacts": [
{
"phone_number": "0429069971",
"first_name": "John",
"last_name": "Smith"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"totalContactsAdded": 123,
"newContactsCount": 123,
"existingContactsCount": 123,
"alreadyInListCount": 123,
"list_contacts": [
{}
]
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Invalid API key"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Rate limit exceeded"
}{
"success": false,
"message": "Internal server error"
}Lists
Create or add contacts to list
Create or reuse contacts by phone number and add them to a list. Send contacts (up to 500) or a single contact object. A phone number that already belongs to one of your contacts reuses that contact. Contacts added this way reach any active batch that uses the list through the batch’s own intake, usually within seconds.
POST
/
api
/
v1
/
lists
/
{list_id}
/
contacts
Create or add contacts to list
curl --request POST \
--url https://api.voxworks.ai/api/v1/lists/{list_id}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contacts": [
{
"phone_number": "0429069971",
"first_name": "John",
"last_name": "Smith"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contacts: [{phone_number: '0429069971', first_name: 'John', last_name: 'Smith'}]
})
};
fetch('https://api.voxworks.ai/api/v1/lists/{list_id}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voxworks.ai/api/v1/lists/{list_id}/contacts"
payload = { "contacts": [
{
"phone_number": "0429069971",
"first_name": "John",
"last_name": "Smith"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"totalContactsAdded": 123,
"newContactsCount": 123,
"existingContactsCount": 123,
"alreadyInListCount": 123,
"list_contacts": [
{}
]
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Invalid API key"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Rate limit exceeded"
}{
"success": false,
"message": "Internal server error"
}Authorizations
API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.
Path Parameters
Unique list ID.
Body
application/json

