Additional Attributes

Additional Attributes provide configurable fields for API resources. An AttributeSet groups AttributeFields, while each affected resource stores its own values for those fields.

Resource endpoints that support Additional Attributes document the shared linking and value structure described here.

Request Flow

Create an AttributeSet and its AttributeFields before linking the set to another resource. The set defines the grouping and ordering, while each field defines one configurable value. The target resource request can then link sets and assign values in one operation.

Attribute Set Keys

The key of an AttributeSet identifies the set when assigning values or referencing its fields. Documentation examples use hyphens (-) to separate words, such as employee-data.

The key must be unique among attribute sets that have not been deleted. Use the same key when submitting additional_attributes and referencing the set in a System Variable template. The field keys inside a set retain their separate field-{formFieldId} format.

Request Structure

Affected create and update endpoints can accept the following keys when their Request Keys table declares them.

Key

Type

Description

attribute_set_ids

array

Links and optionally orders AttributeSets for the affected resource.

additional_attributes

object

Assigns values by the key of an AttributeSet and field key (field-{formFieldId}).

`attribute_set_ids` Formats

attribute_set_ids supports two formats:

IDs Only

{
  "attribute_set_ids": [1, 2, 3]
}

IDs with Sorting

{
  "attribute_set_ids": [
    { "id": 1, "sort_number": 1 },
    { "id": 2, "sort_number": 2 }
  ]
}