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
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
Retrieve all categories belonging to the authenticated company
Field to sort by
Sort direction
Maximum number of results to return
Cursor for pagination
List of announcement categories
Validation error
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-10-14T15:13:21.354Z",
"updated_at": "2025-10-14T15:13:21.354Z",
"translations": {}
}
],
"meta": {}
}Create a new category for the authenticated company
Name of the category
Hex RGB color code (e.g.,
#ff00ffPattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$Category created successfully
Validation error or rate limit exceeded
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-10-14T15:13:21.354Z",
"updated_at": "2025-10-14T15:13:21.354Z",
"translations": {}
},
"meta": {}
}Retrieve a specific category by its encoded ID
Encoded category ID
Category details
Category not found
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-10-14T15:13:21.354Z",
"updated_at": "2025-10-14T15:13:21.354Z",
"translations": {}
},
"meta": {}
}Update an existing category
Encoded category ID
Name of the category
Hex RGB color code (e.g.,
#ff00ffPattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$Category updated successfully
Validation error or category not found
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-10-14T15:13:21.354Z",
"updated_at": "2025-10-14T15:13:21.354Z",
"translations": {}
},
"meta": {}
}Delete an existing category
Encoded category ID
Category deleted successfully
Invalid categoryIdx or category not found
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
Last updated