Skip to main content
POST
Create customer property definition

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. The format field is only applicable to properties of type timestamp; it must be empty for all other types.

description
string
Maximum string length: 512

Response

The created customer property.

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. The format field is only applicable to properties of type timestamp; it must be empty for all other types.

description
string
Maximum string length: 512