Create custom attribute definition

Create a new custom attribute definition for an organisation, or a specific business entity within it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

A unique system identifier for the attribute (e.g., customer_tier, internal_notes).

string
required
length ≥ 1

A user-friendly label for the attribute shown in the UI.

string
enum
required

The module this custom attribute belongs to (e.g., customer, products, contracts).

Allowed:
string
enum
required

The type of data the attribute will store.

If populated, this definition is an entity-specific addition or override.

boolean

If TRUE, this attribute is a Tag. Tags must have data_type = ENUM.

enum_choices

If data_type is ENUM, this stores the list of valid string choices.

An optional default value for the attribute. Must conform to data_type and be one of enum_choices if applicable.

boolean

Indicates if a value is mandatory for this attribute.

boolean

Whether the attribute definition is currently active.

Optional: for controlling display order in UIs.

Optional: further description or help text for the attribute.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json