Skip to main content
POST
Required scopes: customers:rw

Authorizations

​
Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json

The customer property definition fields to update. At least one of name, description, or type_configuration must be provided. The type and type_configuration.format fields are immutable. Unknown fields return a validation error.

​
id
string<uuid>
required

Identifier of the property to update.

​
name
string

New name. Must be unique within the organization.

Maximum string length: 128
​
description
string
Maximum string length: 512
​
type_configuration
object

The update to the property's allowed-value domain. The timestamp format is immutable after property creation.

Example:

Response

The updated customer property.

A customer property definition. type_configuration carries a format only when type is timestamp, and may carry allowed_values for any type; it is an empty object ({}) when neither applies.

​
id
string<uuid>
required

UUID generated by the store.

​
name
string
required

Human-readable property name, unique within the organization.

Maximum string length: 128
​
type
enum<string>
required

Type of the customer property value. Assigned at creation and immutable.

Available options:
bool,
string,
number,
timestamp,
link
​
type_configuration
object
required

Per-type configuration. format is exclusive to properties of type timestamp (sending a non-empty format for other types is rejected with 422). allowed_values, when present, constrains the property to a predefined domain.

Example:
​
has_value
boolean
required

Whether at least one customer has a value set for this property.

​
description
string
Maximum string length: 512