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
name
string
required

Property name, must be non-empty and 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

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:
description
string
Maximum string length: 512

Response

The created 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