Overview
Requires the current version and no pending-join requirement. Historical responses are preserved.
- Permission scope
applications.write- Community feature
applications- 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, with the scope shown above. See authentication and key storage.
Parameters
| Name | Location | Type | Required | Constraints and description |
|---|---|---|---|---|
applicationId | path | string (uuid) | Yes | pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ |
Request body
A JSON request body is required.
| Field | Type | Required | Constraints and description |
|---|---|---|---|
version | integer | Yes | max 9007199254740991, greater than 0 |
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 wait for Retry-After. Upstream Roblox limits may omit budget details. See rate limits and recovery.