Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

contactId
string
required

The contact id.

Minimum string length: 1

Query Parameters

locationId
string
required

The sub-account these contacts belong to. Your access to it is checked on every call. A sub-account with a CRM answers 400.

Body

application/json

The fields to change.

Only the fields you name are changed. An empty string clears one.

phone
string

E.164, or a ten-digit North American number. Any other number needs + or 00. A number another contact has is refused.

Example:

"+13125550142"

firstName
string
Maximum string length: 100
lastName
string
Maximum string length: 100
email
string

Must be a valid email address. It is saved in lower case.

Maximum string length: 254
timezone
string

An IANA zone such as America/Chicago. An empty string clears it, and the campaign's calling window then decides.

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

Values by field key, from GET /api/native-contacts/fields. An empty string clears one. An unknown key, or a value that does not fit its type, is refused.

{key}
any

Response

The contact as it now is.

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