Skip to main content
POST
/
campaigns
/
{campaignId}
/
contacts
Create a contact for a campaign
curl --request POST \
  --url https://api.callers.ai/campaigns/{campaignId}/contacts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data": {},
  "phoneNumber": "<string>",
  "phoneNumbers": [
    "<string>"
  ],
  "timezone": "<string>",
  "archived": false
}
'
{
  "contactId": "<string>",
  "created": true,
  "modified": true
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

​
campaignId
string
required

Query Parameters

​
fixUSPhoneNumber
boolean

Will add 1 to the phone number if it doesn't starts with 1

​
ignorePhoneNumberValidation
boolean

Skip phone number validation for contacts

Body

application/json
​
name
string
required
Minimum string length: 1
​
data
object
required
​
phoneNumber
string
Required string length: 7 - 20
Pattern: ^\+?[\d()-]+$
​
phoneNumbers
string[]
Required string length: 7 - 20
Pattern: ^\+?[\d()-]+$
​
timezone
string
​
archived
boolean
default:false

Response

​
contactId
string
required

ID of the created or updated contact.

​
created
boolean
required

True if a new contact was created.

​
modified
boolean
required

True if an existing contact was modified.