Skip to main content
PATCH
Update custom attribute definition

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

definition_id
string<uuid>
required

Body

application/json
attribute_key_name
string | null

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

Minimum string length: 1
display_name
string | null

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

module
enum<string> | null

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

Available options:
customers,
products,
contracts,
plans,
invoices,
payments
data_type
enum<string> | null

The type of data the attribute will store.

Available options:
STRING,
INTEGER,
FLOAT,
BOOLEAN,
LIST_STRING,
ENUM,
JSON,
DATE
business_entity_id
string<uuid> | null

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

is_tag
boolean | null

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

enum_choices
string[] | null

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

default_value
any | null

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

is_required
boolean | null

Indicates if a value is mandatory for this attribute.

is_enabled
boolean | null

Whether the attribute definition is currently active.

sort_order
integer | null

Optional: for controlling display order in UIs.

description
string | null

Optional: further description or help text for the attribute.

Response

Successful Response

id
string<uuid>
required
organisation_id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
attribute_key_name
string | null

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

Minimum string length: 1
display_name
string | null

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

Minimum string length: 1
module
enum<string> | null

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

Available options:
customers,
products,
contracts,
plans,
invoices,
payments
data_type
enum<string> | null

The type of data the attribute will store.

Available options:
STRING,
INTEGER,
FLOAT,
BOOLEAN,
LIST_STRING,
ENUM,
JSON,
DATE
business_entity_id
string<uuid> | null

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

is_tag
boolean | null

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

enum_choices
string[] | null

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

default_value
any | null

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

is_required
boolean | null

Indicates if a value is mandatory for this attribute.

is_enabled
boolean | null

Whether the attribute definition is currently active.

sort_order
integer | null

Optional: for controlling display order in UIs.

description
string | null

Optional: further description or help text for the attribute.

business_entity
BusinessEntityResponseSchema · object | null

Business Entity Response Schema