Skip to main content
PUT
Update the contact with an address, or create it

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.

Query Parameters

match
string
required

The key that finds the contact to update; its value comes from the body

Allowed value: "email"

Body

application/json
accounts
string[]

Required when the upsert creates; when it updates, replaces the contact's accounts. Live account ids, the primary first

department
string

Applied when the upsert updates; a create refuses it

email
string

Required: the contact's email address

fields
Fields · object | null

Custom field keys to values

first_name
string

A part of the name: when it or last_name is sent, the name is built from the parts sent

last_name
string

A part of the name: when it or first_name is sent, the name is built from the parts sent

name
string

Required when the upsert creates (or first_name / last_name); when it updates, the name as sent

role
string

The contact's buying role, such as Economic Buyer (your workspace's People roles); free text

title
string

The contact's job title

Response

Successful Response

id
string
required
result
enum<string>
required
Available options:
created,
updated
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