Overview
Creates the member if it does not exist. Runs the AutoRank check unless the profile was synced within the staleness window; ?refresh=1 forces a sync first.
- Permission scope
members.read- Community feature
members- 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.read.
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. |
refresh | query | 1 | true | No | Bypass the staleness window: sync from Roblox and run the AutoRank check before responding. |
userId | path | string | Yes | Roblox user id, or a username when `?by=username` is set. |
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.