From 58bc47a792b692bbeb61f05f5b22dc587c60ca3d Mon Sep 17 00:00:00 2001
From: Mike <13852840+velddev@users.noreply.github.com>
Date: Fri, 15 May 2026 01:50:30 +0200
Subject: [PATCH] Document announcement categories
---
api/v1/projects.mdx | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/api/v1/projects.mdx b/api/v1/projects.mdx
index a0f18a4..04e98c6 100644
--- a/api/v1/projects.mdx
+++ b/api/v1/projects.mdx
@@ -146,7 +146,8 @@ curl -X POST https://top.gg/api/v1/projects/@me/announcements \
-H "Content-Type: application/json" \
-d '{
"title": "Version 2.0 Released!",
- "content": "We just released version 2.0 with a bunch of new features and improvements."
+ "content": "We just released version 2.0 with a bunch of new features and improvements.",
+ "category": "new_feature"
}'
```
@@ -160,6 +161,10 @@ curl -X POST https://top.gg/api/v1/projects/@me/announcements \
The announcement body text. Must be between 10 and 2,000 characters.
+
+ The category to publish the announcement under. One of `announcement`, `event`, or `new_feature`. Defaults to `announcement` when omitted.
+
+
### Response fields
@@ -190,7 +195,7 @@ curl -X POST https://top.gg/api/v1/projects/@me/announcements \
|--------|-------------|
| `400` | Invalid project token |
| `404` | Project not found |
-| `422` | Validation error (title or content length violations) |
+| `422` | Validation error (title or content length violations, or unsupported category) |
| `429` | Rate limited - only one announcement every 4 hours |
---