Overview
increment/decrement are clamped to Quota.AwardLimits.API. Quota points never go below zero.
- Permission scope
members.quota.write- Community feature
quota- 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.
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 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.