Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

contactId
string<uuid>
required

Contact ID.

Body

application/json

Fields to change on a contact. Only supplied fields are modified; unknown fields are rejected. A contact must always keep at least one of email or phone.

email
string | null

Email address. Pass null to clear (only allowed if a valid phone remains).

phone
string | null

Phone number. Pass null to clear (only allowed if a valid email remains).

display_name
string | null

Display name. Pass null to clear.

Maximum string length: 255
first_name
string | null

First name. Pass null to clear.

Maximum string length: 255
last_name
string | null

Last name. Pass null to clear.

Maximum string length: 255
email_domain
string | null

Usually auto-derived from email.

Maximum string length: 255
company
string | null

Company. Pass null to clear.

Maximum string length: 255
job_title
string | null

Job title. Pass null to clear.

Maximum string length: 255
address
string | null

Street address. Pass null to clear.

Maximum string length: 500
address2
string | null

Address line 2. Pass null to clear.

Maximum string length: 255
city
string | null

City. Pass null to clear.

Maximum string length: 255
state
string | null

State or region. Pass null to clear.

Maximum string length: 255
country
string | null

Country. Pass null to clear.

Maximum string length: 255
zip_code
string | null

Postal code. Pass null to clear.

Maximum string length: 50
original_source
string | null

Original source. Pass null to clear.

Maximum string length: 255
original_source_detail
string | null

Original source detail. Pass null to clear.

Maximum string length: 255
lead_status
string | null

Lead status. Pass null to clear.

Maximum string length: 100
lifecycle_stage
string | null

Lifecycle stage. Pass null to clear.

Maximum string length: 100
tented_score
number | null

Contact score. Pass null to clear.

unsubscribed
boolean

Global unsubscribe flag.

marketing_email_subscribed
boolean | null

Email marketing subscription state.

marketing_sms_subscribed
boolean | null

SMS marketing subscription state.

marketing_sms_invalid
boolean

Mark the phone number invalid.

custom_fields
object

Editable custom fields keyed by API name. Pass null to clear a value.

Response

The updated contact, including custom_fields.

A contact record including its custom field values.

contact_id
string<uuid>

Contact ID.

display_name
string | null

Display name.

first_name
string | null

First name.

last_name
string | null

Last name.

email
string | null

Email address.

phone
string | null

Phone number.

email_domain
string | null

Domain derived from the email address.

company
string | null

Company.

job_title
string | null

Job title.

address
string | null

Street address.

address2
string | null

Address line 2.

city
string | null

City.

state
string | null

State or region.

country
string | null

Country.

zip_code
string | null

Postal code.

original_source
string | null

How the contact was first created, e.g. Public API.

original_source_detail
string | null

Additional source detail.

lead_status
string | null

Lead status.

lifecycle_stage
string | null

Lifecycle stage.

tented_score
number | null

Contact score.

unsubscribed
boolean

Global unsubscribe flag.

marketing_email_subscribed
boolean | null

Email marketing subscription state.

marketing_sms_subscribed
boolean | null

SMS marketing subscription state.

marketing_email_invalid
boolean

Whether the email address is known to be invalid.

marketing_sms_invalid
boolean

Whether the phone number is known to be invalid.

last_activity_at
string<date-time> | null

Most recent tracked activity.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Last update.

custom_fields
object

Custom field values keyed by field API name. Values are returned as stored strings (or null) regardless of the field's declared value type.