Skip to main content
PATCH
Partially update a Contact

Authorizations

token
string
query
required

Vida API Token

Path Parameters

contactId
string
required

Body

application/json

Writable organization Contact fields. See Contact fields for every field and nested property. PATCH recursively merges objects, replaces arrays/scalars and removes fields set to null. POST creates or shallowly updates top-level fields; use PATCH to preserve nested siblings.

name
string | null
Example:

"Example Person"

title
string | null
email
string | null
Example:

"lead@example.com"

phone
string | null
Example:

"+15551234567"

cnam
string | null

Organization Contact display data only; does not change outbound caller ID.

mobile
string | null
birthday
string | null
gender
string | null
image
string | null
address
object | null
company
object | null
preferredContactMethod
string | null
marketingOptIn
boolean | null
contactSource
string | null
socialMedia
object | null
leadSource
string | null
status
string | null
tags
string[] | null
notes
string | null
agentContext
string | null
customFields
object | null

Custom JSON data, at most 20 top-level keys and 8192 UTF-8 JSON bytes, including existing values after merge.

Example:
lastTask
object | null
lists
object[] | null
appointments
object[] | null

Response

default - undefined