Update Contact

Updates a specific contact's information by its id. If the contact is not yet linked locally, a remote lookup is performed and the local record is backfilled before the update is applied. All fields are optional (PATCH semantics). The client field is not accepted on updates — any request containing a client field will be rejected with a 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the contact.

Query Params
string
^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

Sparse-fieldset selector. Comma-separated list of Contact fields to
include in the response. Omit to return all fields.

Allowed fields: billing_address, billing_email, billing_first_name,
billing_last_name, billing_mobile_phone, billing_organization,
billing_work_phone, client, id, record_created_at,
record_updated_at, shipping_address, shipping_email,
shipping_first_name, shipping_label, shipping_last_name,
shipping_organization, shipping_phone, title, website.

Body Params

Fields to update on a contact. All fields are optional. The client field must NOT be included — requests containing a client field (even with a null value) are rejected. If the updated billing_email combined with the contact's existing client.id matches another contact in the same account, the request is rejected.

billing_address
object

Address fields to update. All fields are optional.

string | null

Primary email address of the billing contact.

string | null

First name of the billing contact.

string | null

Last name of the billing contact.

string | null

Mobile phone number of the billing contact.

string | null

Organization associated with the billing contact.

string | null

Work phone number of the billing contact.

shipping_address
object

Address fields to update. All fields are optional.

string | null

Email for shipping communications.

string | null

First name for the shipping contact.

string | null

Label or designation for the shipping address.

string | null

Last name for the shipping contact.

string | null

Organization for shipping.

string | null

Phone number for shipping communications.

string | null

Job title or position.

string | null

Website URL.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json