Overview
Supply a curated typeId, a custom name, or both when they agree. Discord announcement delivery is best-effort and never rolls back the stored event.
- Permission scope
events.write- Community feature
events- Content type
application/json
Authentication
Send Authorization: Bearer YOUR_API_KEY and X-Clan-Id: COMMUNITY_ID. The community API switch and key must be enabled. The key must have the scope shown above. See authentication and key storage.
No path or query parameters.
Request body
A JSON request body is required.
At least one of these field sets is required: name or typeId.
| Field | Type | Required | Constraints and description |
|---|---|---|---|
name | string | Conditional | min length 1, max length 100 |
typeId | string | null | Conditional | — |
locationPlaceId | integer | Yes | min 1 |
hostUserId | integer | Yes | min 1 |
coHostUserId | integer | null | No | min 1 |
mentionRoleId | string | null | No | pattern ^[0-9]{17,20}$ |
notes | string | null | No | min length 1, max length 1024 |
Error responses
| Status | When it is returned |
|---|---|
| 400 | The request was malformed or failed validation. |
| 401 | The API key is missing, malformed, or not recognised for this community. |
| 403 | The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature. |
| 404 | The requested resource does not exist. |
| 409 | The request conflicts with current state. |
| 429 | Rate limited. |
| 500 | Unexpected server error. |
Rate limits
This operation shares the key’s request budget. On 429, read error.code and follow Retry-After when present. Upstream Roblox limits may omit budget details. Check current state and this endpoint's recovery guidance before retrying a write. See rate limits and recovery.