Create, update and delete category attributes

Creates, updates and deletes category attributes. The primary purpose is to create and edit the attributes to be assigned to categories.
Note: They are generic category attributes and not specific to a category.

Authorizations

Authorization

string

header

required

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json · object[]

action

enum<string>

required

Action type. <br /> Note: <br /> 1) Attribute ID is required only for UPDATE and DELETE actions (not for CREATE). <br /> 2) CREATE action replaces any existing category attribute with the same name.

Available options:

CREATE,

UPDATE,

DELETE

name

string

required

Attribute name

type

enum<string>

required

Supported attribute types for the attribute

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME,

OPTIONS

description

string

Accurate description of the attribute and what it represents

format

string

Attribute format. Currently used only for DATETIME attribute type.

formula

string

JavaScript expression to dynamically compute the attribute value. The data type returned by this expression must match the attribute's data type. <br /> Note: When this is provided, validation is ignored.

id

string

A 24-character system-generated attribute ID

optionsType

enum<string>

Conditionally required to indicate the selectable values for OPTIONS attribute type

Available options:

TEXT,

BOOLEAN,

DECIMAL,

INTEGER,

DATETIME

serialStart

number

Conditionally required to indicate the starting value of SERIAL attribute type. When enabled, the subsequent attribute values increment by 1.

textSubType

enum<string>

Conditionally required for TEXT attribute type

Available options:

SMALL_TEXT,

TEXT_AREA,

HTML

validation

object

Show child attributes

validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

validation.contains

string

Specified value must contain this string

validation.exact

Specified value must exactly match this value

validation.formula

string

JavaScript expression to determine if the value matches

validation.inheritable

boolean

true: Parent attributes inherited to children items <br /> false: Parent attributes not inherited to children items

validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass) <br /> false: Follows existing validation

validation.oneOf

Matches the value if it is one of these

validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

validation.range.max

Specified value must be less than or equal to this value

validation.range.min

Specified value must be greater than or equal to this value

validation.required

boolean

true: Attribute is mandatory <br /> false: Attribute is optional

validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique

Response

200 - application/json

attributes

object

Show child attributes

attributes.failed

object[]

Show child attributes

attributes.failed.errors

string[]

attributes.failed.name

string

Failure reason as stored backend

attributes.success

object[]

Show child attributes

attributes.success.id

string

A 24-character system-generated attribute ID

attributes.success.message

string

Success message

attributes.success.name

string

Attribute name