Skip to main content
POST
/
api
/
v1
/
create-contact
Create contact
curl --request POST \
  --url https://api.voxworks.ai/api/v1/create-contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "0429069971",
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com",
  "title": "Mr"
}
'
{
  "success": true,
  "contact_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Body

application/json
​
phone_number
string
required

Contact phone number. Common local formats are accepted and normalized to E.164.

​
first_name
string
required
​
last_name
string
​
email
string<email>
​
address
string
​
location
string
​
gender
string
​
age
integer
​
title
string

Response

Contact created.

​
success
boolean
required
Example:

true

​
contact_id
string
required