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. 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 fields to change.

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

phone
string
Example:

"+13125550142"

firstName
string
Maximum string length: 100
lastName
string
Maximum string length: 100
email
string
Maximum string length: 254
timezone
string
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
{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