Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId
string
required

The sub-account. It is the only thing that identifies the tenant on these routes, and it is re-checked against your access on every call. A sub-account that keeps its contacts in a CRM answers 400.

Body

application/json

The person.

phone
string
required

Required. E.164, or a ten-digit North American number. Anything else must carry + or 00.

Example:

"+13125550142"

firstName
string
Maximum string length: 100
Example:

"Ana"

lastName
string
Maximum string length: 100
Example:

"Diaz"

email
string
Maximum string length: 254
Example:

"ana@example.com"

timezone
string

An IANA zone such as America/Chicago. An unknown one is refused rather than producing an agent that offers 3am.

Example:

"America/Chicago"

address1
string
Maximum string length: 200
city
string
Maximum string length: 200
state
string
Maximum string length: 200
postalCode
string
Maximum string length: 200
customFields
object

Keyed by field key. A key with no definition is an error.

doNotCall
boolean

Create the contact already suppressed.

doNotCallReason
string
Maximum string length: 500
{key}
any

Response

The contact as stored. suppressedFromHistory appears when this number was already on do-not-call.

success
boolean
required
data
object
required

One person a CRM-less sub-account calls. Deliberately the minimum a dial needs: who they are, how to reach them, what zone they are in, whether they have asked not to be called, plus whatever fields the sub-account defines.

{key}
any