Custom Attribute PATCH API Documentation

Purpose

This endpoint allows updating an existing Custom Attribute’s configuration within Exsited, specifically modifying the list of selectable options for attributes such as radio buttons, dropdowns, or multi-select fields. It enables administrators to maintain accurate and up-to-date option sets that reflect evolving business requirements.

Use Case

When an administrator needs to change, reorder, add, or remove options displayed in a Custom Attribute (example: radio button choices).
When business workflows require updated option values that appear across multiple resources (accounts, users, contacts, etc.).
When maintaining consistency of selectable values across a component, form, or workflow.
When restructuring option sets to improve form usability or data entry accuracy.

Path Parameters

Parameter	Type	Description
attribute_uuid	string	UUID of the Custom Attribute to be updated. Required.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "custom_attribute": {
        "options": [
            {
                "name": "OPTION_NAME_PLACEHOLDER",
                "display_order": DISPLAY_ORDER_PLACEHOLDER
            }
        ]
    }
}

                    

Attribute	Type	Description
custom_attribute	object	Object containing fields to update for the Custom Attribute.
custom_attribute.options	array	List of option objects to be applied to the Custom Attribute. Existing options may be replaced or reordered.
custom_attribute.options[].name	string	Display name of the option to be set.
custom_attribute.options[].display_order	integer	Position index (0-based) determining the display ordering of the option.

Response

The response returns the full updated Custom Attribute object after the system has processed the patch. The output includes the core attribute details (UUID, name, type, status), the complete list of option items including existing and newly added values, and their system-generated order. It also includes the “use in” configuration showing where the attribute is enabled across resources, providing full visibility into how the updated attribute behaves within the platform.

Response Body

                JSON
              

                      {
    "custom_attribute": {
        "uuid": "CUSTOM_ATTRIBUTE_UUID_PLACEHOLDER",
        "status": "ATTRIBUTE_STATUS_PLACEHOLDER",
        "name": "ATTRIBUTE_NAME_PLACEHOLDER",
        "display_name": "ATTRIBUTE_DISPLAY_NAME_PLACEHOLDER",
        "type": "ATTRIBUTE_TYPE_PLACEHOLDER",
        "min_value": "",
        "max_value": "",
        "max_length": "",
        "use_in": [
            {
                "resource": "RESOURCE_NAME_PLACEHOLDER",
                "required": "REQUIRED_FLAG_PLACEHOLDER",
                "unique": "UNIQUE_FLAG_PLACEHOLDER",
                "associated_account_groups": [],
                "associated_user_groups": [],
                "associated_item_groups": [],
                "enabled": "ENABLED_FLAG_PLACEHOLDER"
            }
        ],
        "options": [
            {
                "name": "OPTION_NAME_PLACEHOLDER_1",
                "display_order": DISPLAY_ORDER_PLACEHOLDER_1
            },
            {
                "name": "OPTION_NAME_PLACEHOLDER_2",
                "display_order": DISPLAY_ORDER_PLACEHOLDER_2
            }
        ],
        "encrypt_data": "ENCRYPT_DATA_FLAG_PLACEHOLDER"
    }
}

                    

Attribute	Type	Description
custom_attribute	object	The updated Custom Attribute object.
custom_attribute.uuid	string	UUID of the Custom Attribute.
custom_attribute.status	string	Attribute status (example: ACTIVE).
custom_attribute.name	string	Internal name of the Custom Attribute.
custom_attribute.display_name	string	User-facing display name.
custom_attribute.type	string	Attribute type (example: RADIO_BUTTON, DROPDOWN).
custom_attribute.min_value	string	Minimum value allowed (if applicable).
custom_attribute.max_value	string	Maximum value allowed (if applicable).
custom_attribute.max_length	string	Maximum allowed length (if applicable).
custom_attribute.use_in	array	List of resources where the attribute is enabled.
custom_attribute.use_in[].resource	string	Resource name (account, user, contact, etc.).
custom_attribute.use_in[].required	string	Indicates if the attribute is mandatory.
custom_attribute.use_in[].unique	string	Indicates if the value must be unique.
custom_attribute.use_in[].associated_account_groups	array	Account groups linked to the attribute.
custom_attribute.use_in[].associated_user_groups	array	User groups linked to the attribute.
custom_attribute.use_in[].associated_item_groups	array	Item groups linked to the attribute.
custom_attribute.use_in[].enabled	string	Indicates whether the attribute is enabled for the resource.
custom_attribute.options	array	List of all final option objects in the attribute.
custom_attribute.options[].name	string	Option label.
custom_attribute.options[].display_order	integer	System-generated option ordering.
custom_attribute.encrypt_data	string	Indicates if the data is stored in encrypted form.