Customers

Update customer

Use when updating customer details (e.g. name, email, or metadata). Identify by id or external_customer_id.

put/customers

Query parameters

idstring

Customer ID

external_customer_idstring

Customer External ID

Request body

address_citystring

address_city is the updated city name with maximum 100 characters

address_countrystring

address_country is the updated two-letter ISO 3166-1 alpha-2 country code

address_line1string

address_line1 is the updated primary address line with maximum 255 characters

address_line2string

address_line2 is the updated secondary address line with maximum 255 characters

address_postal_codestring

address_postal_code is the updated postal code with maximum 20 characters

address_statestring

address_state is the updated state, province, or region name with maximum 100 characters

emailstring

email is the updated email address and must be a valid email format if provided

external_idstring

external_id is the updated external identifier for the customer

metadataobject

metadata contains updated key-value pairs that will replace existing metadata

namestring

name is the updated name or company name for the customer

Response

OK

address_citystring

AddressCity is the city of the customer's address

address_countrystring

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

address_line1string

AddressLine1 is the first line of the customer's address

address_line2string

AddressLine2 is the second line of the customer's address

address_postal_codestring

AddressPostalCode is the postal code of the customer's address

address_statestring

AddressState is the state of the customer's address

created_atstring date-time
created_bystring
emailstring

Email is the email of the customer

environment_idstring

EnvironmentID is the environment identifier for the customer

external_idstring

ExternalID is the external identifier for the customer

idstring

ID is the unique identifier for the customer

metadataobject

Metadata

namestring

Name is the name of the customer

status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes