Create customer property definition
Creates a new customer property schema entry for the organization.
The property id is a UUID generated by the store. An organization can have at most 30 customer properties.
customers:rwAuthorizations
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
Property name, must be non-empty and unique within the organization.
128Type of the customer property value. Assigned at creation and immutable.
bool, string, number, timestamp, link 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.
512Response
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.
UUID generated by the store.
Human-readable property name, unique within the organization.
128Type of the customer property value. Assigned at creation and immutable.
bool, string, number, timestamp, link 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.
Whether at least one customer has a value set for this property.
512