PATCH
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
/
options
/
{optionId}
curl --request PATCH \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options/{optionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "color": "<string>",
  "isArchived": true,
  "order": 123
}'
{
    "status": true,
    "message": "Attribute option updated successfully"
}

Description

This API endpoint allows the update of a select/multiselect attribute option. Select/multiselect attribute options are used to define various choices available for a select/multiselect attribute associated with a collection or list.

Path

target
string
required

Specifies the target type, which can be either “collection” or “list.”

targetId
string
required

A unique identifier for the target, either a collection ID or a list ID, depending on the target type.

attributeId
string
required

The ID of the select/multiselect attribute to which the option belongs.

optionId
string
required

The ID of the select/multiselect attribute option to be updated.

Request Body

name
string

The name of the select/multiselect option.

color
string

Hex color code representing the color associated with the option.

isArchived
boolean

Indicates whether the option is archived (true/false).

order
integer

The order or ranking of the option.

Response

status
boolean

Indicates the success or failure of the select/multiselect option update. In this case, true signifies a successful operation.

message
string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful update of the attribute select/multiselect option with the message “Attribute option updated successfully.”