Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

locationId
string
required

The sub-account's stable location id.

Minimum string length: 1

Body

application/json

The lead.

One lead. phone is required; everything else is optional. Fields nested one level under contact, data or lead are read as well, for senders that wrap the lead. Arrays and deeper objects are ignored.

phone
string
required

The lead's number. E.164 preferred; a North American number without a country code is completed. phone_number and mobile are read as this field.

Example:

"+13125550142"

first_name
string
Example:

"Ana"

last_name
string
Example:

"Diaz"

name
string

A full name, split into first and last when the two are not sent.

Example:

"Ana Diaz"

email
string
Example:

"ana@example.com"

timezone
string

IANA zone. Decides when the lead may be called.

Example:

"America/Chicago"

address1
string
Example:

"1 Main St"

city
string
Example:

"Chicago"

state
string
Example:

"IL"

postalCode
string
Example:

"60601"

{key}

Any of the sub-account's custom fields, by its key or its name. A field the sub-account does not have is ignored and named in ignoredFields.

Response

A contact with that number already existed and was updated.

success
boolean
required
data
object
required