Skip to main content
PATCH
Update Attribute Status Option

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

string
required
Specifies the target type, which can be either “collection” or “list.”
string
required
A unique identifier for the target, either a collection ID or a list ID, depending on the target type.
string
required
The ID of the status attribute to which the option belongs.
string
required
The ID of the status attribute option to be updated.

Request Body

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

Response

boolean
Indicates the success or failure of the status option update. In this case, true signifies a successful operation.
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.”