Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

contactId
string
required

The contact id.

Example:

"44210"

Body

application/json

At least one field. Leave a field out to keep it; send null to clear a field that can be null.

name
string

Cannot be null.

Required string length: 1 - 150
type
enum<string>

Only contact, which turns a lead into a contact. A contact cannot become a lead. Cannot be null.

Available options:
contact
title
string | null

null clears the field.

Maximum string length: 255
company
string | null

null clears the field.

Maximum string length: 100
industry
string | null

null clears the field.

Maximum string length: 100
website
string | null

null clears the field.

Maximum string length: 100
address
string | null

null clears the field.

Maximum string length: 255
city
string | null

null clears the field.

Maximum string length: 255
state
string | null

null clears the field.

Maximum string length: 255
zip
string | null

null clears the field.

Maximum string length: 15
countryCode
string

ISO 3166-1 alpha-2. Cannot be null.

phones
string[]

Replaces the whole list. Up to 20, in E.164.

Maximum array length: 20
emails
string[]

Replaces the whole list. Up to 20.

Maximum array length: 20
customFields
object

Merged by key: keys you send are set, a key sent as null is removed, and other keys stay. At most 100 keys, removals included.

favoriteUserId
string | null

null clears the owner.

Response

The updated contact.

A contact or lead, with every number, email, tag and custom field.

id
string
required

Contact id.

Example:

"44210"

type
enum<string>
required
Available options:
contact,
lead
name
string | null
required

The contact's name. null only for an older contact saved without one: contacts created through this API always have a name, and an update cannot clear it.

Required string length: 1 - 150
Example:

"Jane Doe"

title
string | null
required
Maximum string length: 255
company
string | null
required
Maximum string length: 100
industry
string | null
required
Maximum string length: 100
website
string | null
required
Maximum string length: 100
address
string | null
required
Maximum string length: 255
city
string | null
required
Maximum string length: 255
state
string | null
required
Maximum string length: 255
zip
string | null
required
Maximum string length: 15
country
object | null
required
phones
string[]
required

Every number on the contact, in E.164.

Example:
emails
string[]
required

Every email on the contact.

Example:
tags
object[]
required

The contact's contact tags. Integration tags are not listed.

customFields
object
required

Custom field values as strings, keyed by the field name from List contact fields.

Example:
favoriteUserId
string | null
required

The user who owns the contact.

Example:

"7"

source
string
required

Where the contact came from. Contacts created through this API have api. Read-only.

Example:

"api"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required

Time of the last change. It moves on changes made through this API, the Dashboard contact form and CSV import. Dashboard bulk edits, CRM list sync, and renaming or deleting a contact tag do not move it.

dashboardUrl
string
required

Link to the contact's page in the CloudTalk Dashboard. It carries no credentials: the person must be signed in to your company's Dashboard, and your company must have Contacts in its menu, otherwise the Dashboard opens their default page. Read-only.

Example:

"https://dashboard.cloudtalk.io/menu/contacts/details/44210"