Skip to main content
POST
Update contact

Authorizations

x-api-token
string
header
required

API key for the user making the request. This can be found via the Developer Settings page in the dashboard.

team_id
string
header
required

Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.

Path Parameters

id
string
required

The unique ID of the Contact you want to update.

Body

application/json
first_name
string

The first name of the Contact.

last_name
string

The last name of the Contact.

phone_number
string

The phone number of the Contact.

name
string

The full name of the Contact.

email
string

The email address associated with the Contact.

country_code
string | null

The country code for the Contact's phone number. Used when the phone number does not start with '+'.

custom_attributes
object[]

Custom attributes to update on the Contact.

Response

Successful response

The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.

data
object
required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.

error
object | null

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.