Skip to main content
PATCH
Replace a contact

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

id
string
required

Contact id.

Body

application/json
email
string
required

The only required field. Case-insensitive and unique per workspace.

firstName
string | null
lastName
string | null
company
string | null
phone
string | null
type
string | null

client | colleague | partner | friend | family | other. Unknown values become "other".

Response

The updated contact.

contact
object
required