Update a system status
Path Parameters
- Type: integerstatus
System Id requiredStatusSystem ID
Body·
required
application/json
StatusSystem values to be updated
- Type: integeractivated
Whether this status system is active and available for use; 1 = active, 0 = inactive
- Type: stringallow
_move Serialized JSON rule set defining which status transitions are permitted within this status system
- Type: stringcolor
Status system color
- Type: booleancustom
Whether this is a user-defined custom status system (1) or a built-in system status system (0)
- Type: stringicon
Status system icon
- Type: stringicon
_prefix Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)
- Type: stringmodule
Module type this status system is associated with (e.g. contact, deal, todo)
- Type: stringname
Status system name
- Type: stringsystem
_name Internal system-level identifier for this status system, used to reference built-in status systems by a stable key
- Type: integerweight
Display order position; lower values appear first
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for put/status-system/{statusSystemId}
curl https://test.boost.space/api/status-system/1 \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"id": 42,
"color": "#1f6feb",
"icon_prefix": "string",
"icon": "string",
"module": "string",
"weight": 1,
"name": "Sample name",
"system_name": "Sample system_name",
"activated": 1,
"custom": true,
"allow_move": "string",
"boostId": "string"
}'
{
"id": 42,
"color": "#1f6feb",
"icon_prefix": "string",
"icon": "string",
"module": "string",
"weight": 1,
"name": "Sample name",
"system_name": "Sample system_name",
"activated": 1,
"custom": true,
"allow_move": "string",
"boostId": "string"
}