Update custom attribute definition

patch

https://api.zenskar.com/custom_attributes/{definition_id}

Update an existing custom attribute definition. Note: attribute_key_name and data_type are generally not updatable after creation.

Path Params

definition_id

uuid

required

Body Params

attribute_key_name

length ≥ 1

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

display_name

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

module

enum

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

data_type

enum

The type of data the attribute will store.

business_entity_id

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

is_tag

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.

default_value

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

is_required

Indicates if a value is mandatory for this attribute.

is_enabled

Whether the attribute definition is currently active.

sort_order

Optional: for controlling display order in UIs.

description

Optional: further description or help text for the attribute.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response