Statuses

Create a status

post/status/

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/status/
  • Auth: HTTP bearer

Request body

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

created_user_idinteger

ID of the user who created this status

namestring required

Status name

colorstring

Status color

iconstring required

Status icon

icon_prefixstring required

Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

weightinteger

Display order position; lower values appear first

status_system_idinteger

ID of the StatusSystem this status belongs to

boostIdstring

Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

spacesinteger[]

IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem

Example request

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "created_user_id": 42,
  "name": "Sample name",
  "color": "#1f6feb",
  "icon": "string",
  "icon_prefix": "string",
  "weight": 1,
  "status_system_id": 42,
  "boostId": "string",
  "spaces": [
    1
  ],
  "statusSystem": {
    "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"
  }
}

Response

Status record created

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

created_user_idinteger

ID of the user who created this status

namestring required

Status name

colorstring

Status color

iconstring required

Status icon

icon_prefixstring required

Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

weightinteger

Display order position; lower values appear first

status_system_idinteger

ID of the StatusSystem this status belongs to

boostIdstring

Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

spacesinteger[]

IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem

Example response

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "created_user_id": 42,
  "name": "Sample name",
  "color": "#1f6feb",
  "icon": "string",
  "icon_prefix": "string",
  "weight": 1,
  "status_system_id": 42,
  "boostId": "string",
  "spaces": [
    1
  ],
  "statusSystem": {
    "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.