Update Contact

PATCH /v2/partner/contacts/{id}

Required scopes

partner:contacts:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID	`updateContact`
Tags	Audience

Parameters

Name	In	Type	Description
id *	path	id

Request body

Required

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`contact`
team_id *	id	UUID v4.
unique_id	string
name_first	string
name_last	string
name_title	string
name_suffix	string
email	string
phone_home	string
phone_mobile	string
phone_work	string
address	string
address2	string
city	string
state	string
post_code	string
county	string
country	string
birthdate	string (date)	ISO 8601 date 'YYYY-MM-DD'.
timezone	timezone	IANA timezone identifier (e.g. America/Chicago). UTC offsets rejected.
sms_verified *	boolean
sms_opted_in *	boolean
sms_authorized *	boolean
sms_unsubscribed *	boolean
email_verified *	boolean
email_opted_in *	boolean
email_authorized *	boolean
email_unsubscribed *	boolean
meta_public *	object
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
last_seen_at	updated_at	RFC 3339 / ISO 8601 timestamp.
active_journey_ids *	id[]
completed_objective_keys *	string[]

Responses

200

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`contact`
team_id *	id	UUID v4.
unique_id	string
name_first	string
name_last	string
name_title	string
name_suffix	string
email	string
phone_home	string
phone_mobile	string
phone_work	string
address	string
address2	string
city	string
state	string
post_code	string
county	string
country	string
birthdate	string (date)	ISO 8601 date 'YYYY-MM-DD'.
timezone	timezone	IANA timezone identifier (e.g. America/Chicago). UTC offsets rejected.
sms_verified *	boolean
sms_opted_in *	boolean
sms_authorized *	boolean
sms_unsubscribed *	boolean
email_verified *	boolean
email_opted_in *	boolean
email_authorized *	boolean
email_unsubscribed *	boolean
meta_public *	object
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
last_seen_at	updated_at	RFC 3339 / ISO 8601 timestamp.
active_journey_ids *	id[]
completed_objective_keys *	string[]

Example request

PATCH https://api.digitalonboarding.com/v2/partner/contacts/{id}
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }