Overview
Writes an audit entry and re-runs AutoRank. increment/decrement are clamped to Experience.AwardLimits.API; set deliberately is not.
- Permission scope
members.experience.write- Community feature
experience- Content type
application/json
Authentication
Two headers are required
Send a current cl_live_… key as a Bearer token and the community’s Clan ID separately.
Authorization: Bearer YOUR_API_KEY
X-Clan-Id: COMMUNITY_IDThe key must be enabled, the community API master switch must be on, and the key must include members.experience.write.
Parameters
| Name | Location | Type | Required | Constraints and description |
|---|---|---|---|---|
by | query | userId | username | No | How to interpret the identifier in the path. Prefer `username`: under Roblox's scoped user identifiers an in-experience user id is not a global one. |
userId | path | string | Yes | Roblox user id, or a username when `?by=username` is set. |
Request body
A JSON request body is required.
| Field | Type | Required | Constraints and description |
|---|---|---|---|
op | increment | decrement | set | Yes | `increment` and `decrement` are clamped to the community's per-call API award limit; `set` is not. |
amount | integer | Yes | min 0, max 9007199254740991 |
reason | string | No | min length 1, max length 256 |
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 endpoint shares the API key’s configured request budget. A 429 response includes a Retry-After header and limit, remaining, and resetMs values in error.details. Wait for the indicated interval before retrying.
Related endpoints
Examples use placeholders. Never put an API key in source control, a Roblox place file, screenshots, or support messages.