PATCH
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
/
status
/
{optionId}
Update Attribute Status Option
curl --request PATCH \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status/{optionId} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "color": "<string>",
  "isArchived": true,
  "celebrationEnabled": true
}'
{
    "status": true,
    "message": "Attribute status updated successfully"
}

​
Description

This API endpoint allows the update of a status attribute option. Status attribute options are used to define different stages or states that an item can go through in 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 status attribute to which the option belongs.
​
optionId
string
required
The ID of the status attribute option to be updated.

​
Request Body

​
name
string
The name of the status option.
​
color
string
Hex color code representing the color associated with the option.
​
isArchived
boolean
Indicates whether the option is archived (true/false).
​
celebrationEnabled
boolean
Indicates whether celebration is enabled for the option (true/false).

​
Response

​
status
boolean
Indicates the success or failure of the status 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 status option with the message “Attribute status updated successfully.”
{
    "status": true,
    "message": "Attribute status updated successfully"
}