Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

contact_id
string
required

Body

application/json
accounts
string[]

Replaces the contact's accounts: live account ids, the primary first

department
string

The contact's department (free text); null or blank clears it

fields
Fields · object | null

Custom field keys to values

first_name
string

Sent without name, rebuilds the name from the parts; null or blank clears it

last_name
string

Sent without name, rebuilds the name from the parts; null or blank clears it

name
string

The contact's full name; cannot be cleared

role
string

The contact's buying role, such as Economic Buyer (free text); null or blank clears it

title
string

The contact's job title; null or blank clears it

Response

200 - application/json

Successful Response

id
string
required
account
string | null

The id of the contact's primary account; null when it has none (it may still be on accounts)

accounts
string[]

The ids of every account the contact is on, the primary first

crm_contact_id
string | null

The contact's id in your CRM

department
string | null
email
string | null
engagements
integer
default:0

Engagements in the last 90 days

fields
Fields · object
first_name
string | null
is_key_contact
boolean
default:false
last_engagement_date
string | null

YYYY-MM-DD (UTC) of the latest engagement, at any time; null when none

last_name
string | null
name
string | null
origin
enum<string> | null

Where the contact first came from; null when not recorded

Available options:
crm,
statisfy
role
string | null
sentiment
enum<string> | null

null when none is recorded

Available options:
negative,
neutral,
positive
title
string | null