Announcement Categories

Announcement Categories help organize your announcements into logical groups, making it easier for users to find relevant updates. Categories can be customized with names and colors to match your prod

Category object

Announcement Categories have the following fields

Field	Details
id integer	Category ID
idx string	Encoded category ID
name string	Category name
color string	Hex RGB color code
company_id integer	Company ID
created_at string	The date & time the category was created (UTC timezone)
updated_at string	The date & time the category was last updated (UTC timezone)
translations object	Localized category names

Endpoints

You can use the following endpoints to manage Announcement Categories

Get all announcement categories

get

Retrieve all categories belonging to the authenticated company

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Query parameters

sortBystring · enumOptional

Field to sort by

Possible values:

sortstring · enumOptional

Sort direction

Possible values:

limitintegerOptional

Maximum number of results to return

afterstringOptional

Cursor for pagination

Responses

200

List of announcement categories

application/json

400

Validation error

application/json

get

/api/v1/announcement-categories

HTTPcURLJavaScriptPython

GET /api/v1/announcement-categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "idx": "text",
      "name": "text",
      "color": "#ff00ff",
      "company_id": 1,
      "created_at": "2025-12-11T21:33:30.738Z",
      "updated_at": "2025-12-11T21:33:30.738Z",
      "translations": {}
    }
  ],
  "meta": {}
}

Create a new announcement category

post

Create a new category for the authenticated company

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Body

application/json

namestring · max: 255Required

Name of the category

colorstringOptional

Hex RGB color code (e.g.,

Example: #ff00ffPattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Responses

200

Category created successfully

application/json

400

Validation error or rate limit exceeded

application/json

post

/api/v1/announcement-categories

HTTPcURLJavaScriptPython

POST /api/v1/announcement-categories HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "color": "#ff00ff"
}

{
  "data": {
    "id": 1,
    "idx": "text",
    "name": "text",
    "color": "#ff00ff",
    "company_id": 1,
    "created_at": "2025-12-11T21:33:30.738Z",
    "updated_at": "2025-12-11T21:33:30.738Z",
    "translations": {}
  },
  "meta": {}
}

Get announcement category by ID

get

Retrieve a specific category by its encoded ID

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

categoryIdxstringRequired

Encoded category ID

Responses

200

Category details

application/json

404

Category not found

application/json

get

/api/v1/announcement-categories/{categoryIdx}

HTTPcURLJavaScriptPython

GET /api/v1/announcement-categories/{categoryIdx} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "idx": "text",
    "name": "text",
    "color": "#ff00ff",
    "company_id": 1,
    "created_at": "2025-12-11T21:33:30.738Z",
    "updated_at": "2025-12-11T21:33:30.738Z",
    "translations": {}
  },
  "meta": {}
}

Update announcement category

post

Update an existing category

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

categoryIdxstringRequired

Encoded category ID

Body

application/json

namestring · max: 255Optional

Name of the category

colorstringOptional

Hex RGB color code (e.g.,

Example: #ff00ffPattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Responses

200

Category updated successfully

application/json

400

Validation error or category not found

application/json

post

/api/v1/announcement-categories/{categoryIdx}

HTTPcURLJavaScriptPython

POST /api/v1/announcement-categories/{categoryIdx} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "color": "#ff00ff"
}

{
  "data": {
    "id": 1,
    "idx": "text",
    "name": "text",
    "color": "#ff00ff",
    "company_id": 1,
    "created_at": "2025-12-11T21:33:30.738Z",
    "updated_at": "2025-12-11T21:33:30.738Z",
    "translations": {}
  },
  "meta": {}
}

Delete announcement category

delete

Delete an existing category

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

categoryIdxstringRequired

Encoded category ID

Responses

200

Category deleted successfully

application/json

400

Invalid categoryIdx or category not found

application/json

delete

/api/v1/announcement-categories/{categoryIdx}

HTTPcURLJavaScriptPython

DELETE /api/v1/announcement-categories/{categoryIdx} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

Related

• Announcements - Learn how to manage announcements that use these categories