/v2/members/{userId}/medalsAwards stack up to 1,000 total occurrences per member — awarding a medal the member already holds appends another occurrence. name is the medal's name, which is unique per community.
members.medals.writemedalsapplication/jsonSend 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.
| 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. |
A JSON request body is required.
| Field | Type | Required | Constraints and description |
|---|---|---|---|
name | string | Yes | min length 1 |
| 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. |
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.
The member
{
"data": {
"userId": 1234567,
"username": "PixelComet482",
"experience": 250,
"quotaPoints": 3,
"medals": [
"Long Service"
],
"qualifications": [
"Marksman"
],
"currentRank": {
"uniqueId": 900001,
"id": 10,
"name": "Private",
"experience": 200,
"locked": false
},
"nextRank": {
"uniqueId": 900001,
"id": 10,
"name": "Private",
"experience": 200,
"locked": false
},
"perks": {
"boosting": true,
"primary": true
},
"createdAt": 1735689600000,
"lastUpdatedAt": 1735689600000
}
}