> For the complete documentation index, see [llms.txt](https://developers.frill.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.frill.co/api/reference/announcement-categories.md).

# 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                                                      |
| ---------------------------------------------- | ------------------------------------------------------------ |
| <p><strong>id</strong><br>integer</p>          | Category ID                                                  |
| <p><strong>idx</strong><br>string</p>          | Encoded category ID                                          |
| <p><strong>name</strong><br>string</p>         | Category name                                                |
| <p><strong>color</strong><br>string</p>        | Hex RGB color code                                           |
| <p><strong>company\_id</strong><br>integer</p> | Company ID                                                   |
| <p><strong>created\_at</strong><br>string</p>  | The date & time the category was created (UTC timezone)      |
| <p><strong>updated\_at</strong><br>string</p>  | The date & time the category was last updated (UTC timezone) |
| <p><strong>translations</strong><br>object</p> | Localized category names                                     |

### Endpoints

You can use the following endpoints to manage Announcement Categories

{% openapi src="/files/yZwHZ70AHTRRVb1v2VPA" path="/api/v1/announcement-categories" method="get" %}
[announcement\_categories.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-5b1dbb533a7af50ef64e6b35f55b784ae400d605%2Fannouncement_categories.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/yZwHZ70AHTRRVb1v2VPA" path="/api/v1/announcement-categories" method="post" %}
[announcement\_categories.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-5b1dbb533a7af50ef64e6b35f55b784ae400d605%2Fannouncement_categories.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/yZwHZ70AHTRRVb1v2VPA" path="/api/v1/announcement-categories/{categoryIdx}" method="get" %}
[announcement\_categories.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-5b1dbb533a7af50ef64e6b35f55b784ae400d605%2Fannouncement_categories.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/yZwHZ70AHTRRVb1v2VPA" path="/api/v1/announcement-categories/{categoryIdx}" method="post" %}
[announcement\_categories.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-5b1dbb533a7af50ef64e6b35f55b784ae400d605%2Fannouncement_categories.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/yZwHZ70AHTRRVb1v2VPA" path="/api/v1/announcement-categories/{categoryIdx}" method="delete" %}
[announcement\_categories.yaml](https://554427104-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIpllvC2FiBlBNS7dyV5t%2Fuploads%2Fgit-blob-5b1dbb533a7af50ef64e6b35f55b784ae400d605%2Fannouncement_categories.yaml?alt=media)
{% endopenapi %}

## Related

* [Announcements](/api/reference/announcements.md) - Learn how to manage announcements that use these categories