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

The ID of the property to update.

​
name
string

The updated property name. It must be unique within the organization.

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

The changes to the property's allowed values. You cannot change the format after creating the property. The allowed_values field is not supported for text properties.

Example:

Response

The updated customer property definition.

​
id
string<uuid>
required

Unique identifier generated when the property is created.

​
name
string
required

A human-readable property name. It must be unique within the organization. The property name is also displayed in the Text app.

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

The customer property value type. You cannot change type after creating the property. A text value can contain up to 5,000 characters. Properties of type text do not support allowed_values.

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

The configuration for a customer property type. Only timestamp properties support format. Properties of type text do not support allowed_values.

Example:
​
has_value
boolean
required

If true, at least one customer has a value set for this property.

​
description
string
Maximum string length: 512