{"openapi":"3.1.0","info":{"title":"Clan Labs API v2","version":"3.0.0","description":"The public Clan Labs API v2 contract. Read the guides and generated endpoint reference at https://docs.clanlabs.co/api-reference."},"servers":[{"url":"https://api.clanlabs.co","description":"Clan Labs API v2"}],"security":[{"BearerKey":[],"ClanId":[]}],"tags":[{"name":"Members","description":"Member profiles and progression"},{"name":"Configuration","description":"Ranks, medals, qualifications"},{"name":"Moderation","description":"Blacklists and warnings"},{"name":"Events","description":"Community event lifecycle and curated types"}],"paths":{"/v2/members":{"get":{"summary":"List members","tags":["Members"],"description":"Cursor paginated on `userId`. Pass `meta.nextCursor` as `?cursor=` for the next page; it is null when there are no further pages.\n\n**Requires permission:** `members.read` — View members (Read member profiles and management data.)\n\n**Feature:** `members`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string"},"example":"1234567","in":"query","name":"cursor","required":false,"description":"The `userId` of the last member from the previous page. Take it from `meta.nextCursor`."},{"schema":{"type":"string"},"example":"50","in":"query","name":"limit","required":false,"description":"Page size, 1-100. Defaults to 50. Larger values are clamped to 100."}],"x-required-permission":"members.read","x-community-feature":"members","responses":{"200":{"description":"A page of members","content":{"application/json":{"schema":{"description":"A page of members","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}":{"get":{"summary":"Fetch one member","tags":["Members"],"description":"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.\n\n**Requires permission:** `members.read` — View members (Read member profiles and management data.)\n\n**Feature:** `members`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string","enum":["1","true"]},"in":"query","name":"refresh","required":false,"description":"Bypass the staleness window: sync from Roblox and run the AutoRank check before responding."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.read","x-community-feature":"members","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/experience":{"post":{"summary":"Change a member's experience","tags":["Members"],"description":"Writes an audit entry and re-runs AutoRank. `increment`/`decrement` are clamped to `Experience.AwardLimits.API`; `set` deliberately is not. A scheduled AutoRank outcome may return 504 with operation status headers after the experience change is saved. Check the operation before repeating the experience change.\n\n**Requires permission:** `members.experience.write` — Manage member experience (Award, remove, or set member experience.)\n\n**Feature:** `experience`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["op","amount"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["increment","decrement","set"],"description":"`increment` and `decrement` are clamped to the community's per-call API award limit; `set` is not."},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991,"example":10},"reason":{"type":"string","minLength":1,"maxLength":256}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.experience.write","x-community-feature":"experience","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/quota-points":{"post":{"summary":"Change a member's quota points","tags":["Members"],"description":"`increment`/`decrement` are clamped to `Quota.AwardLimits.API`. Quota points never go below zero.\n\n**Requires permission:** `members.quota.write` — Manage member quota (Award, remove, or set member quota points.)\n\n**Feature:** `quota`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["op","amount"],"additionalProperties":false,"properties":{"op":{"type":"string","enum":["increment","decrement","set"],"description":"`increment` and `decrement` are clamped to the community's per-call API award limit; `set` is not."},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991,"example":10},"reason":{"type":"string","minLength":1,"maxLength":256}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.quota.write","x-community-feature":"quota","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}/rank":{"put":{"summary":"Set a member's rank","tags":["Members"],"description":"Identify the rank by `rankUniqueId` (the Roblox role resource id) or `rankId` (the 0-255 rank number).\n\n**Requires permission:** `members.ranks.write` — Manage member ranks (Promote, demote, or set member ranks.)\n\n**Feature:** `rank-management`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"oneOf":[{"required":["rankUniqueId"]},{"required":["rankId"]}],"properties":{"rankUniqueId":{"type":"number","example":900002},"rankId":{"type":"number","minimum":0,"maximum":255,"example":20}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.ranks.write","x-community-feature":"rank-management","responses":{"200":{"description":"The updated member","content":{"application/json":{"schema":{"description":"The updated member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/rank/promote":{"post":{"summary":"Promote a member one rank","tags":["Members"],"description":"Moves the member to the next rank by rank number.\n\n**Requires permission:** `members.ranks.write` — Manage member ranks (Promote, demote, or set member ranks.)\n\n**Feature:** `rank-management`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.ranks.write","x-community-feature":"rank-management","responses":{"200":{"description":"The updated member","content":{"application/json":{"schema":{"description":"The updated member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/rank/demote":{"post":{"summary":"Demote a member one rank","tags":["Members"],"description":"Moves the member to the previous rank by rank number.\n\n**Requires permission:** `members.ranks.write` — Manage member ranks (Promote, demote, or set member ranks.)\n\n**Feature:** `rank-management`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.ranks.write","x-community-feature":"rank-management","responses":{"200":{"description":"The updated member","content":{"application/json":{"schema":{"description":"The updated member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/medals":{"post":{"summary":"Award a medal","tags":["Members"],"description":"Awards 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.\n\n**Requires permission:** `members.medals.write` — Manage member medals (Award or remove medals from members.)\n\n**Feature:** `medals`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"example":"Long Service"}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.medals.write","x-community-feature":"medals","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}/medals/{name}":{"delete":{"summary":"Remove a medal","tags":["Members"],"description":"**Requires permission:** `members.medals.write` — Manage member medals (Award or remove medals from members.)\n\n**Feature:** `medals`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."},{"schema":{"type":"string"},"example":"Long Service","in":"path","name":"name","required":true,"description":"The medal's name."}],"x-required-permission":"members.medals.write","x-community-feature":"medals","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}/qualifications":{"post":{"summary":"Award a qualification","tags":["Members"],"description":"Idempotent — awarding a qualification the member already holds is a no-op. `name` is the qualification's name, which is unique per community.\n\n**Requires permission:** `members.qualifications.write` — Manage member qualifications (Award or remove qualifications from members.)\n\n**Feature:** `qualifications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"example":"Marksman"}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.qualifications.write","x-community-feature":"qualifications","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}/qualifications/{name}":{"delete":{"summary":"Remove a qualification","tags":["Members"],"description":"**Requires permission:** `members.qualifications.write` — Manage member qualifications (Award or remove qualifications from members.)\n\n**Feature:** `qualifications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."},{"schema":{"type":"string"},"example":"Marksman","in":"path","name":"name","required":true,"description":"The qualification's name."}],"x-required-permission":"members.qualifications.write","x-community-feature":"qualifications","responses":{"200":{"description":"The member","content":{"application/json":{"schema":{"description":"The member","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/ranks":{"get":{"summary":"List ranks","tags":["Configuration"],"description":"Ordered by Roblox rank number ascending. Note `uniqueId` (the Roblox role resource id) is what rank changes target, not `rankId`.\n\n**Requires permission:** `ranks.read` — View ranks (Read configured community ranks.)\n\n**Feature:** `ranks`. Communities whose tier or trial does not include it receive 403.","x-required-permission":"ranks.read","x-community-feature":"ranks","responses":{"200":{"description":"The community's ranks","content":{"application/json":{"schema":{"description":"The community's ranks","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Rank"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/ranks/{uniqueId}":{"get":{"summary":"Fetch one rank","tags":["Configuration"],"description":"**Requires permission:** `ranks.read` — View ranks (Read configured community ranks.)\n\n**Feature:** `ranks`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string"},"example":"900001","in":"path","name":"uniqueId","required":true,"description":"The rank's Roblox role resource id."}],"x-required-permission":"ranks.read","x-community-feature":"ranks","responses":{"200":{"description":"The rank","content":{"application/json":{"schema":{"description":"The rank","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Rank"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/medals":{"get":{"summary":"List medals","tags":["Configuration"],"description":"**Requires permission:** `medals.read` — View medals (Read configured community medals.)\n\n**Feature:** `medals`. Communities whose tier or trial does not include it receive 403.","x-required-permission":"medals.read","x-community-feature":"medals","responses":{"200":{"description":"The community's medals","content":{"application/json":{"schema":{"description":"The community's medals","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogEntry"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/medals/{name}":{"get":{"summary":"Fetch one medal by name","tags":["Configuration"],"description":"`name` is the medal's name, which is unique per community.\n\n**Requires permission:** `medals.read` — View medals (Read configured community medals.)\n\n**Feature:** `medals`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string"},"example":"Long Service","in":"path","name":"name","required":true}],"x-required-permission":"medals.read","x-community-feature":"medals","responses":{"200":{"description":"The medal","content":{"application/json":{"schema":{"description":"The medal","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CatalogEntry"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/qualifications":{"get":{"summary":"List qualifications","tags":["Configuration"],"description":"**Requires permission:** `qualifications.read` — View qualifications (Read configured community qualifications.)\n\n**Feature:** `qualifications`. Communities whose tier or trial does not include it receive 403.","x-required-permission":"qualifications.read","x-community-feature":"qualifications","responses":{"200":{"description":"The community's qualifications","content":{"application/json":{"schema":{"description":"The community's qualifications","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogEntry"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/qualifications/{name}":{"get":{"summary":"Fetch one qualification by name","tags":["Configuration"],"description":"`name` is the qualification's name, which is unique per community.\n\n**Requires permission:** `qualifications.read` — View qualifications (Read configured community qualifications.)\n\n**Feature:** `qualifications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string"},"example":"Marksman","in":"path","name":"name","required":true}],"x-required-permission":"qualifications.read","x-community-feature":"qualifications","responses":{"200":{"description":"The qualification","content":{"application/json":{"schema":{"description":"The qualification","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CatalogEntry"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/blacklists":{"get":{"summary":"List blacklist entries","tags":["Moderation"],"description":"**Requires permission:** `blacklists.read` — View blacklists (Read community blacklist records.)\n\n**Feature:** `blacklists`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["User","Group"]},"in":"query","name":"type","required":false,"description":"Restrict to one blacklist type."}],"x-required-permission":"blacklists.read","x-community-feature":"blacklists","responses":{"200":{"description":"The community's blacklist entries","content":{"application/json":{"schema":{"description":"The community's blacklist entries","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Blacklist"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Create a blacklist entry","tags":["Moderation"],"description":"A community may blacklist a given target once; a duplicate returns 409.\n\n**Requires permission:** `blacklists.write` — Manage blacklists (Create, update, or remove blacklist records.)\n\n**Feature:** `blacklists`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","id","name","description"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["User","Group"]},"id":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Roblox user id or group id, per `type`.","example":987654},"name":{"type":"string","minLength":1,"description":"Display name for the entry. The canonical Roblox name is used instead whenever it can be resolved; this is the fallback when Roblox is unreachable.","example":"Troublemaker"},"description":{"type":"string","minLength":1,"example":"Exploiting"}}}}}},"x-required-permission":"blacklists.write","x-community-feature":"blacklists","responses":{"201":{"description":"The created entry","content":{"application/json":{"schema":{"description":"The created entry","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Blacklist"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"That target is already blacklisted.","content":{"application/json":{"schema":{"description":"That target is already blacklisted.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/blacklists/{type}/{id}":{"get":{"summary":"Fetch one blacklist entry","tags":["Moderation"],"description":"**Requires permission:** `blacklists.read` — View blacklists (Read community blacklist records.)\n\n**Feature:** `blacklists`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["User","Group"]},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"example":"987654","in":"path","name":"id","required":true,"description":"Roblox user id or group id, per `type`."}],"x-required-permission":"blacklists.read","x-community-feature":"blacklists","responses":{"200":{"description":"The blacklist entry","content":{"application/json":{"schema":{"description":"The blacklist entry","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Blacklist"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"patch":{"summary":"Update a blacklist entry's description","tags":["Moderation"],"description":"**Requires permission:** `blacklists.write` — Manage blacklists (Create, update, or remove blacklist records.)\n\n**Feature:** `blacklists`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["description"],"additionalProperties":false,"properties":{"description":{"type":"string","minLength":1,"example":"Repeat offender"}}}}}},"parameters":[{"schema":{"type":"string","enum":["User","Group"]},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"example":"987654","in":"path","name":"id","required":true,"description":"Roblox user id or group id, per `type`."}],"x-required-permission":"blacklists.write","x-community-feature":"blacklists","responses":{"200":{"description":"The blacklist entry","content":{"application/json":{"schema":{"description":"The blacklist entry","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Blacklist"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"delete":{"summary":"Remove a blacklist entry","tags":["Moderation"],"description":"**Requires permission:** `blacklists.write` — Manage blacklists (Create, update, or remove blacklist records.)\n\n**Feature:** `blacklists`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["User","Group"]},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"example":"987654","in":"path","name":"id","required":true,"description":"Roblox user id or group id, per `type`."}],"x-required-permission":"blacklists.write","x-community-feature":"blacklists","responses":{"204":{"description":"Removed"},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/warnings":{"get":{"summary":"List warnings","tags":["Moderation"],"description":"Newest first. Offset paginated with `limit` and `skip`. An unrecognised `targetUsername` returns an empty list rather than everything.\n\n**Requires permission:** `warnings.read` — View warnings (Read community warning records.)\n\n**Feature:** `warnings`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"in":"query","name":"targetId","required":false,"description":"Filter by Roblox user id."},{"schema":{"type":"string"},"in":"query","name":"targetUsername","required":false,"description":"Filter by Roblox username."},{"schema":{"type":"string","enum":["Low","Medium","High"]},"in":"query","name":"severity","required":false},{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"in":"query","name":"limit","required":false,"description":"Page size, 1-200. Defaults to 50."},{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"in":"query","name":"skip","required":false,"description":"Rows to skip. Defaults to 0."}],"x-required-permission":"warnings.read","x-community-feature":"warnings","responses":{"200":{"description":"A page of warnings","content":{"application/json":{"schema":{"description":"A page of warnings","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Issue a warning","tags":["Moderation"],"description":"Identify the target by exactly one of `targetUserId` or `targetUsername`. An optional invoker identifies the in-game administrator; the API key is captured separately on the audit entry.\n\n**Requires permission:** `warnings.write` — Manage warnings (Create, update, or remove warning records.)\n\n**Feature:** `warnings`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["severity","description"],"additionalProperties":false,"oneOf":[{"required":["targetUserId"]},{"required":["targetUsername"]}],"properties":{"targetUserId":{"type":"integer","minimum":1,"maximum":9007199254740991},"targetUsername":{"type":"string","minLength":3,"maxLength":20,"example":"PixelComet482"},"severity":{"type":"string","enum":["Low","Medium","High"]},"description":{"type":"string","minLength":1,"maxLength":1024},"invokerUserId":{"type":"integer","minimum":1,"maximum":9007199254740991},"invokerUsername":{"type":"string","minLength":3,"maxLength":20,"example":"OrbitSprinter73"}}}}}},"x-required-permission":"warnings.write","x-community-feature":"warnings","responses":{"201":{"description":"The issued warning","content":{"application/json":{"schema":{"description":"The issued warning","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Warning"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/warnings/{id}":{"get":{"summary":"Fetch one warning","tags":["Moderation"],"description":"**Requires permission:** `warnings.read` — View warnings (Read community warning records.)\n\n**Feature:** `warnings`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"example":"1","in":"path","name":"id","required":true,"description":"The warning's per-community sequential id."}],"x-required-permission":"warnings.read","x-community-feature":"warnings","responses":{"200":{"description":"The warning","content":{"application/json":{"schema":{"description":"The warning","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Warning"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"patch":{"summary":"Update a warning","tags":["Moderation"],"description":"Supply at least one field. The target cannot be changed.\n\n**Requires permission:** `warnings.write` — Manage warnings (Create, update, or remove warning records.)\n\n**Feature:** `warnings`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"severity":{"type":"string","enum":["Low","Medium","High"]},"description":{"type":"string","minLength":1,"maxLength":1024}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"example":"1","in":"path","name":"id","required":true,"description":"The warning's per-community sequential id."}],"x-required-permission":"warnings.write","x-community-feature":"warnings","responses":{"200":{"description":"The warning","content":{"application/json":{"schema":{"description":"The warning","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Warning"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"delete":{"summary":"Delete a warning","tags":["Moderation"],"description":"Writes the full pre-delete snapshot so the Dashboard can roll the deletion back.\n\n**Requires permission:** `warnings.write` — Manage warnings (Create, update, or remove warning records.)\n\n**Feature:** `warnings`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","pattern":"^(?:0|[1-9][0-9]*)$"},"example":"1","in":"path","name":"id","required":true,"description":"The warning's per-community sequential id."}],"x-required-permission":"warnings.write","x-community-feature":"warnings","responses":{"204":{"description":"Deleted"},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/members/{userId}/suspensions":{"get":{"summary":"List a member's suspensions","tags":["Members"],"description":"Newest first, including restored and cancelled records. Write permission implies read because the permission catalog has no suspension-read scope.\n\n**Requires permission:** `members.suspensions.write` — Manage member suspensions (Create, restore, or cancel member suspensions.)\n\n**Feature:** `suspensions`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.suspensions.write","x-community-feature":"suspensions","responses":{"200":{"description":"The member's suspension history","content":{"application/json":{"schema":{"description":"The member's suspension history","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Suspension"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Suspend a member","tags":["Members"],"description":"Claims the suspension before changing Roblox and verifies the resulting role. A member may hold only one active suspension. An unresolved scheduled write returns 504 with an operation status Location and retains the active claim; do not retry before checking that operation.\n\n**Requires permission:** `members.suspensions.write` — Manage member suspensions (Create, restore, or cancel member suspensions.)\n\n**Feature:** `suspensions`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["durationMs","reason"],"additionalProperties":false,"properties":{"durationMs":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":1024}}}}}},"parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.suspensions.write","x-community-feature":"suspensions","responses":{"201":{"description":"The created suspension","content":{"application/json":{"schema":{"description":"The created suspension","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Suspension"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/suspensions/restore":{"post":{"summary":"Restore a member's active suspension","tags":["Members"],"description":"Puts the member back on the rank they held before the suspension and marks it `restored`. The role is only changed if the member still holds the suspended role, so a manual promotion or demotion is preserved. An earlier unresolved scheduled write returns 409 with its operation status Location. A restore that returns 504 retains its bounded lease; late confirmation makes the record due for automatic closure after that lease expires.\n\n**Requires permission:** `members.suspensions.write` — Manage member suspensions (Create, restore, or cancel member suspensions.)\n\n**Feature:** `suspensions`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.suspensions.write","x-community-feature":"suspensions","responses":{"200":{"description":"The updated suspension","content":{"application/json":{"schema":{"description":"The updated suspension","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Suspension"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The suspension conflicts with current state. If an earlier Roblox write is unresolved, status headers identify that operation; check it before retrying. The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The suspension conflicts with current state. If an earlier Roblox write is unresolved, status headers identify that operation; check it before retrying. The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"A Roblox request timed out or has an unresolved outcome. With scheduling enabled, outcome-pending-check-status and provider-rejected-408 include Location and X-Roblox-Operation-Id only when current access to the frozen operation is verified; check authorized status before retrying. Revoked or unverifiable access omits references while retaining the pending outcome. The reference identifies the saved operation; status reports whether it remains pending or is terminal. With scheduling disabled, roblox_cloud_timeout has no operation or status headers. A timeout does not confirm success or failure; check the member's Roblox state before repeating a write without an accessible reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"outcome-pending-check-status or provider-rejected-408 for scheduled work, or roblox_cloud_timeout for a direct request timeout.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key."},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"Roblox has not confirmed this operation. Check its status before retrying. Do not resubmit while pending; poll statusUrl with the same API key.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}}}}},"/v2/members/{userId}/suspensions/cancel":{"post":{"summary":"Cancel a member's active suspension","tags":["Members"],"description":"Voids the suspension without touching the member's Roblox rank, marking it `cancelled`. An earlier unresolved scheduled write returns 409 with its operation status Location.\n\n**Requires permission:** `members.suspensions.write` — Manage member suspensions (Create, restore, or cancel member suspensions.)\n\n**Feature:** `suspensions`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["userId","username"],"default":"userId"},"in":"query","name":"by","required":false,"description":"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."},{"schema":{"type":"string"},"example":"1234567","in":"path","name":"userId","required":true,"description":"Roblox user id, or a username when `?by=username` is set."}],"x-required-permission":"members.suspensions.write","x-community-feature":"suspensions","responses":{"200":{"description":"The updated suspension","content":{"application/json":{"schema":{"description":"The updated suspension","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Suspension"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The suspension conflicts with current state. If an earlier Roblox write is unresolved, status headers identify that operation; check it before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The suspension conflicts with current state. If an earlier Roblox write is unresolved, status headers identify that operation; check it before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}}}}},"/v2/events":{"get":{"summary":"List events","tags":["Events"],"description":"Newest events first, using cursor pagination.\n\n**Requires permission:** `events.read` — View events (Read community events and curated event types.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","enum":["Scheduled","Started","Finished","Cancelled"]},"in":"query","name":"status","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"cursor","required":false,"description":"Last event id from the previous page."},{"schema":{"type":"string","pattern":"^[1-9][0-9]*$"},"in":"query","name":"limit","required":false,"description":"Page size, 1-100. Defaults to 25."}],"x-required-permission":"events.read","x-community-feature":"events","responses":{"200":{"description":"A page of events","content":{"application/json":{"schema":{"description":"A page of events","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Create and announce an event","tags":["Events"],"description":"Supply a curated `typeId`, a custom `name`, or both when they agree. Discord announcement delivery is best-effort and never rolls back the stored event.\n\n**Requires permission:** `events.write` — Manage events (Create, run, finish, cancel, and announce community events.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["locationPlaceId","hostUserId"],"anyOf":[{"required":["name"]},{"required":["typeId"]}],"properties":{"name":{"type":"string","minLength":1,"maxLength":100},"typeId":{"type":["string","null"],"format":"uuid"},"locationPlaceId":{"type":"integer","minimum":1},"hostUserId":{"type":"integer","minimum":1},"coHostUserId":{"type":["integer","null"],"minimum":1},"mentionRoleId":{"type":["string","null"],"pattern":"^[0-9]{17,20}$"},"notes":{"type":["string","null"],"minLength":1,"maxLength":1024}}}}}},"x-required-permission":"events.write","x-community-feature":"events","responses":{"201":{"description":"The persisted event","content":{"application/json":{"schema":{"description":"The persisted event","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/events/types":{"get":{"summary":"List curated event types","tags":["Events"],"description":"**Requires permission:** `events.read` — View events (Read community events and curated event types.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","x-required-permission":"events.read","x-community-feature":"events","responses":{"200":{"description":"The configured curated event types","content":{"application/json":{"schema":{"description":"The configured curated event types","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventType"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/events/locations":{"get":{"summary":"List approved event locations","tags":["Events"],"description":"**Requires permission:** `events.read` — View events (Read community events and curated event types.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","x-required-permission":"events.read","x-community-feature":"events","responses":{"200":{"description":"Approved community and division games","content":{"application/json":{"schema":{"description":"Approved community and division games","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventLocation"}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/events/{eventId}":{"get":{"summary":"Fetch one event","tags":["Events"],"description":"**Requires permission:** `events.read` — View events (Read community events and curated event types.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid"},"example":"8ca14e0a-60cb-4b43-8a91-0c77bc521d81","in":"path","name":"eventId","required":true,"description":"The event's stable UUID."}],"x-required-permission":"events.read","x-community-feature":"events","responses":{"200":{"description":"The event","content":{"application/json":{"schema":{"description":"The event","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/events/{eventId}/cancel":{"post":{"summary":"Cancel an event","tags":["Events"],"description":"**Requires permission:** `events.write` — Manage events (Create, run, finish, cancel, and announce community events.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid"},"example":"8ca14e0a-60cb-4b43-8a91-0c77bc521d81","in":"path","name":"eventId","required":true,"description":"The event's stable UUID."}],"x-required-permission":"events.write","x-community-feature":"events","responses":{"200":{"description":"The cancelled event","content":{"application/json":{"schema":{"description":"The cancelled event","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/events/{eventId}/finish":{"post":{"summary":"Finish an event","tags":["Events"],"description":"Accepts JSON or multipart/form-data. In multipart requests, `attendeeUserIds` is a JSON array field and `screenshot` is an image file up to 10 MB. Screenshot delivery to Discord is best-effort; the bot persists durable message and attachment references. A 504 with Roblox operation status headers can occur after the event and awards are committed; check those operations rather than finishing the event again.\n\n**Requires permission:** `events.write` — Manage events (Create, run, finish, cancel, and announce community events.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"attendeeUserIds":{"type":"array","maxItems":100,"items":{"type":"integer","minimum":1}},"screenshot":{"type":"string","format":"binary"}}}},"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"properties":{"attendeeUserIds":{"type":"array","maxItems":100,"items":{"type":"integer","minimum":1}},"screenshot":{"type":"string","format":"binary"}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"example":"8ca14e0a-60cb-4b43-8a91-0c77bc521d81","in":"path","name":"eventId","required":true,"description":"The event's stable UUID."}],"x-required-permission":"events.write","x-community-feature":"events","responses":{"200":{"description":"The finished event","content":{"application/json":{"schema":{"description":"The finished event","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","headers":{},"content":{"application/json":{"schema":{"description":"The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"actor-authorization-revoked, insufficient_scope or feature_unavailable.","example":"actor-authorization-revoked"},"message":{"type":"string","example":"API authorization changed before the request was sent"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"actor-authorization-revoked","message":"API authorization changed before the request was sent"}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. member-review-required returns the message: An earlier request for this member needs administrator review. This new request was not submitted. This admission failure has no operation metadata or status headers. When present, status headers identify the operation; check its cancellation or failure before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"deadline-cancelled-before-dispatch, member-review-required or another current-state conflict.","example":"deadline-cancelled-before-dispatch"},"message":{"type":"string","example":"deadline-cancelled-before-dispatch"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"},"unsentCancelled":{"type":"boolean"}}}}}},"example":{"error":{"code":"deadline-cancelled-before-dispatch","message":"deadline-cancelled-before-dispatch","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","unsentCancelled":true}}}}}}},"429":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied. Provider throttling returns 30; queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"queue-full, rate_limit_exceeded or provider-rejected-429.","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"502":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true,"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}}}}}},"503":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"roblox_scheduler_unavailable"},"message":{"type":"string","example":"Roblox scheduling is temporarily unavailable"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"roblox_scheduler_unavailable","message":"Roblox scheduling is temporarily unavailable"}}}}}},"504":{"description":"The event and awards are committed, but one or more Roblox rank outcomes are pending. When present, error.details.operations lists currently accessible references; check those operations and the members' Roblox state before retrying. Location and X-Roblox-Operation-Id identify the first operation in that list of accessible references; they do not represent all attendees. Details and operation headers are omitted when no reference is accessible.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."},"Retry-After":{"schema":{"type":"string"},"description":"When supplied, seconds to wait before polling the authorized status URL. Service-mode pending responses use 2. This is not permission to repeat the mutation."}},"content":{"application/json":{"schema":{"description":"The event and awards are committed, but one or more Roblox rank outcomes are pending. When present, error.details.operations lists currently accessible references; check those operations and the members' Roblox state before retrying. Location and X-Roblox-Operation-Id identify the first operation in that list of accessible references; they do not represent all attendees. Details and operation headers are omitted when no reference is accessible.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"outcome-pending-check-status"},"message":{"type":"string","example":"The event is finished, but Roblox rank outcomes are pending. Check the operations before retrying."},"details":{"type":"object","additionalProperties":true,"required":["operations"],"properties":{"operationId":{"type":"string","description":"First pending operation, also identified by the status headers."},"statusUrl":{"type":"string","description":"Status URL for the first pending operation."},"operations":{"type":"array","minItems":1,"description":"Currently accessible pending attendee rank operations. Poll each URL with the same API key that finished the event; inaccessible references are omitted.","items":{"type":"object","required":["operationId","statusUrl"],"properties":{"operationId":{"type":"string","pattern":"^[a-f0-9]{64}$"},"statusUrl":{"type":"string"}}}}}}}}},"example":{"error":{"code":"outcome-pending-check-status","message":"The event is finished, but Roblox rank outcomes are pending. Check the operations before retrying.","details":{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","operations":[{"operationId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},{"operationId":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","statusUrl":"/v2/roblox-operations/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}]}}}}}}}}}},"/v2/events/{eventId}/announce":{"post":{"summary":"Create a fresh Discord announcement","tags":["Events"],"description":"Queues a best-effort re-announcement. The bot replaces the durable announcement reference only after the new message exists.\n\n**Requires permission:** `events.write` — Manage events (Create, run, finish, cancel, and announce community events.)\n\n**Feature:** `events`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid"},"example":"8ca14e0a-60cb-4b43-8a91-0c77bc521d81","in":"path","name":"eventId","required":true,"description":"The event's stable UUID."}],"x-required-permission":"events.write","x-community-feature":"events","responses":{"202":{"description":"The event whose announcement was queued","content":{"application/json":{"schema":{"description":"The event whose announcement was queued","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/roblox-operations/ranks":{"post":{"summary":"Queue a rank change","tags":["Members"],"description":"Opt-in asynchronous operation. Idempotency-Key is required. 202 means accepted, not completed. Unsent work expires at its deadline; sent work may reconcile afterward. Poll Location before retrying. Matching accepted intent can be replayed after losing rank-management access while the original key retains its permission and API access; new admission requires rank-management access.\n\n**Requires permission:** `members.ranks.write` — Manage member ranks (Promote, demote, or set member ranks.)\n\n**Feature:** `rank-management`. New admission returns 403 when the community's tier or trial does not include it. Matching accepted intent can still be replayed with the same enabled API key, its required permission and community API access.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["userId","roleId","expectedRoleId"],"properties":{"userId":{"type":"integer","minimum":1,"maximum":9007199254740991},"roleId":{"type":"integer","minimum":1,"maximum":9007199254740991},"expectedRoleId":{"type":"integer","minimum":1,"maximum":9007199254740991},"deadlineSeconds":{"type":"integer","minimum":5,"maximum":3600,"default":300,"description":"Seconds until unsent work expires; defaults to 300 when omitted. Sent work may continue reconciling after this deadline."}}}}}},"parameters":[{"schema":{"type":"string","pattern":"^[a-zA-Z0-9._:-]{1,100}$"},"in":"header","name":"idempotency-key","required":true,"description":"Stable key for one logical operation; conflicting reuse returns 409."}],"x-required-permission":"members.ranks.write","x-community-feature":"rank-management","responses":{"202":{"description":"Accepted with operation ID and status URL","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."}},"content":{"application/json":{"schema":{"description":"Accepted with operation ID and status URL","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":true,"required":["id","status","kind","userId","createdAt","deadline","result","error","needsReview","statusUrl"],"example":{"id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","status":"queued","kind":"rank","userId":123,"createdAt":"2026-10-01T00:00:00.000Z","deadline":"2026-10-01T00:05:00.000Z","result":null,"error":null,"needsReview":false,"statusUrl":"/v2/roblox-operations/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},"properties":{"id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["queued","running","reconciling","completed","failed","cancelled","expired"]},"kind":{"type":"string","enum":["rank"]},"userId":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"deadline":{"type":"string","format":"date-time"},"result":{"type":["null","object"],"additionalProperties":true,"properties":{"message":{"type":"string"},"changed":{"type":"boolean"},"roleId":{"type":"integer"}}},"error":{"type":["null","string"]},"statusUrl":{"type":"string"},"needsReview":{"type":"boolean","description":"An unresolved sent request needs administrator review. It protects this member but does not occupy active queue admission."}}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request failed validation","headers":{},"content":{"application/json":{"schema":{"description":"The request failed validation","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"validation_failed"},"message":{"type":"string","example":"The request failed validation"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"validation_failed","message":"The request failed validation"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"description":"Unauthorized","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"unauthorized"},"message":{"type":"string","example":"Unauthorized"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"unauthorized","message":"Unauthorized"}}}}}},"403":{"description":"insufficient_scope means the API key lacks members.ranks.write. feature_unavailable means community API access is unavailable or new admission lacks rank-management access. Matching accepted intent can be replayed after losing rank-management access while the same enabled API key retains members.ranks.write and community API access.","headers":{},"content":{"application/json":{"schema":{"description":"insufficient_scope means the API key lacks members.ranks.write. feature_unavailable means community API access is unavailable or new admission lacks rank-management access. Matching accepted intent can be replayed after losing rank-management access while the same enabled API key retains members.ranks.write and community API access.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"insufficient_scope"},"message":{"type":"string","example":"The API key lacks the required permission"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"insufficient_scope","message":"The API key lacks the required permission"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"description":"Not Found","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"not_found"},"message":{"type":"string","example":"Not Found"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"not_found","message":"Not Found"}}}}}},"409":{"description":"deduplication-conflict means Idempotency-Key conflicts with existing intent or current state. When present, Location and X-Roblox-Operation-Id identify the existing authorized operation; check it before submitting replacement intent. member-review-required means an earlier request for this member needs administrator review and this new request was not submitted. privacy-restricted means a current data-rights restriction prevents admission or idempotent replay. No operation metadata, Location or X-Roblox-Operation-Id is returned for member-review-required or privacy-restricted.","headers":{"Location":{"schema":{"type":"string"},"description":"Authorized operation status URL. Check the outcome before retrying."},"X-Roblox-Operation-Id":{"schema":{"type":"string"},"description":"Durable operation ID for authorized status lookup."}},"content":{"application/json":{"schema":{"description":"deduplication-conflict means Idempotency-Key conflicts with existing intent or current state. When present, Location and X-Roblox-Operation-Id identify the existing authorized operation; check it before submitting replacement intent. member-review-required means an earlier request for this member needs administrator review and this new request was not submitted. privacy-restricted means a current data-rights restriction prevents admission or idempotent replay. No operation metadata, Location or X-Roblox-Operation-Id is returned for member-review-required or privacy-restricted.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member-review-required"},"message":{"type":"string","example":"An earlier request for this member needs administrator review. This new request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"member-review-required","message":"An earlier request for this member needs administrator review. This new request was not submitted."}}}}}},"429":{"description":"Rate limited or queue-full admission exhaustion. Retry-After may be absent for queue-full; retry the same Idempotency-Key with bounded exponential backoff.","headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait when supplied for rate limiting. Queue-full admission exhaustion may omit this header."}},"content":{"application/json":{"schema":{"description":"Rate limited or queue-full admission exhaustion. Retry-After may be absent for queue-full; retry the same Idempotency-Key with bounded exponential backoff.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"queue-full"},"message":{"type":"string","example":"The community's request queue is full. This request was not submitted."},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"queue-full","message":"The community's request queue is full. This request was not submitted."}}}}}},"500":{"description":"Internal Server Error","headers":{},"content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"internal_error"},"message":{"type":"string","example":"Internal Server Error"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"internal_error","message":"Internal Server Error"}}}}}},"502":{"description":"Roblox rejected the community connection. Review its authorization before retrying.","headers":{},"content":{"application/json":{"schema":{"description":"Roblox rejected the community connection. Review its authorization before retrying.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"authorization-intervention-required"},"message":{"type":"string","example":"authorization-intervention-required"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"authorization-intervention-required","message":"authorization-intervention-required"}}}}}},"503":{"description":"Roblox operations are disabled or scheduling is temporarily unavailable","headers":{},"content":{"application/json":{"schema":{"description":"Roblox operations are disabled or scheduling is temporarily unavailable","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"scheduler_disabled means the asynchronous feature is off; scheduler-unavailable or roblox_scheduler_unavailable means the runtime is temporarily unavailable; scheduler-disabled means dispatch admission is disabled.","enum":["scheduler_disabled","scheduler-unavailable","scheduler-disabled","roblox_scheduler_unavailable"],"example":"scheduler_disabled"},"message":{"type":"string","example":"Roblox operations are not enabled"},"details":{"type":"object","additionalProperties":true}}}},"example":{"error":{"code":"scheduler_disabled","message":"Roblox operations are not enabled"}}}}}}}}},"/v2/roblox-operations/{id}":{"get":{"summary":"Read a Roblox operation","tags":["Members"],"description":"Requires permission: the original operation's saved API permission, on the same enabled API key. Tenant and current connection ownership and the saved operation's current data-rights restrictions are rechecked. A restricted operation returns 409 privacy-restricted without operation metadata or status headers. No additional members.read permission is required.","parameters":[{"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"in":"path","name":"id","required":true}],"x-required-permission":"original-operation-permission","x-community-feature":"api-access","responses":{"200":{"description":"Authorized operation result","content":{"application/json":{"schema":{"description":"Authorized operation result","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":true,"required":["id","status","kind","userId","createdAt","deadline","result","error","needsReview"],"example":{"id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","status":"queued","kind":"rank","userId":123,"createdAt":"2026-10-01T00:00:00.000Z","deadline":"2026-10-01T00:05:00.000Z","result":null,"error":null,"needsReview":false},"properties":{"id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["queued","running","reconciling","completed","failed","cancelled","expired"]},"kind":{"type":"string","enum":["rank","join"]},"userId":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"deadline":{"type":"string","format":"date-time"},"result":{"type":["null","object"],"additionalProperties":true,"properties":{"message":{"type":"string"},"changed":{"type":"boolean"},"roleId":{"type":"integer"}}},"error":{"type":["null","string"]},"statusUrl":{"type":"string"},"needsReview":{"type":"boolean","description":"An unresolved sent request needs administrator review. It protects this member but does not occupy active queue admission."}}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request failed validation","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"validation_failed","message":"The request failed validation"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"validation_failed"},"message":{"type":"string","example":"The request failed validation"},"details":{"type":"object","additionalProperties":true}}}},"description":"The request failed validation"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"unauthorized","message":"Unauthorized"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"unauthorized"},"message":{"type":"string","example":"Unauthorized"},"details":{"type":"object","additionalProperties":true}}}},"description":"Unauthorized"}}}},"403":{"description":"The API key lacks the required permission","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"insufficient_scope","message":"The API key lacks the required permission"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"insufficient_scope"},"message":{"type":"string","example":"The API key lacks the required permission"},"details":{"type":"object","additionalProperties":true}}}},"description":"The API key lacks the required permission"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"not_found","message":"Not Found"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"not_found"},"message":{"type":"string","example":"Not Found"},"details":{"type":"object","additionalProperties":true}}}},"description":"Not Found"}}}},"409":{"description":"A current data-rights restriction prevents access or cancellation. No operation metadata, Location or X-Roblox-Operation-Id is returned.","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"privacy-restricted","message":"privacy-restricted"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"privacy-restricted"},"message":{"type":"string","example":"privacy-restricted"},"details":{"type":"object","additionalProperties":true}}}},"description":"A current data-rights restriction prevents access or cancellation. No operation metadata, Location or X-Roblox-Operation-Id is returned."}}}},"429":{"description":"Rate limited. Wait at least the supplied Retry-After interval before polling or cancelling again.","headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait before retrying the operation request."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"rate_limit_exceeded","message":"Too Many Requests"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"rate_limit_exceeded"},"message":{"type":"string","example":"Too Many Requests"},"details":{"type":"object","additionalProperties":true}}}},"description":"Rate limited. Wait at least the supplied Retry-After interval before polling or cancelling again."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"internal_error","message":"Internal Server Error"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"internal_error"},"message":{"type":"string","example":"Internal Server Error"},"details":{"type":"object","additionalProperties":true}}}},"description":"Internal Server Error"}}}},"503":{"description":"Roblox operations are disabled or scheduling is temporarily unavailable","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"scheduler_disabled","message":"Roblox operations are not enabled"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"scheduler_disabled means the asynchronous feature is off; scheduler-unavailable or roblox_scheduler_unavailable means the runtime is temporarily unavailable; scheduler-disabled means dispatch admission is disabled.","enum":["scheduler_disabled","scheduler-unavailable","scheduler-disabled","roblox_scheduler_unavailable"],"example":"scheduler_disabled"},"message":{"type":"string","example":"Roblox operations are not enabled"},"details":{"type":"object","additionalProperties":true}}}},"description":"Roblox operations are disabled or scheduling is temporarily unavailable"}}}}}},"delete":{"summary":"Cancel unsent Roblox work","tags":["Members"],"description":"Requires permission: the original operation's saved API permission, on the same enabled API key. Tenant and current connection ownership and the saved operation's current data-rights restrictions are rechecked. A restricted operation returns 409 privacy-restricted without operation metadata or status headers. No additional members.read permission is required.","parameters":[{"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"in":"path","name":"id","required":true}],"x-required-permission":"original-operation-permission","x-community-feature":"api-access","responses":{"200":{"description":"Authorized operation result","content":{"application/json":{"schema":{"description":"Authorized operation result","type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","outcome"],"example":{"id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","outcome":"cancelled"},"properties":{"id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"outcome":{"type":"string","enum":["cancelled","in-flight","terminal","not-found"]}}},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request failed validation","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"validation_failed","message":"The request failed validation"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"validation_failed"},"message":{"type":"string","example":"The request failed validation"},"details":{"type":"object","additionalProperties":true}}}},"description":"The request failed validation"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"unauthorized","message":"Unauthorized"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"unauthorized"},"message":{"type":"string","example":"Unauthorized"},"details":{"type":"object","additionalProperties":true}}}},"description":"Unauthorized"}}}},"403":{"description":"The API key lacks the required permission","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"insufficient_scope","message":"The API key lacks the required permission"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"insufficient_scope"},"message":{"type":"string","example":"The API key lacks the required permission"},"details":{"type":"object","additionalProperties":true}}}},"description":"The API key lacks the required permission"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"not_found","message":"Not Found"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"not_found"},"message":{"type":"string","example":"Not Found"},"details":{"type":"object","additionalProperties":true}}}},"description":"Not Found"}}}},"409":{"description":"A current data-rights restriction prevents access or cancellation. No operation metadata, Location or X-Roblox-Operation-Id is returned.","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"privacy-restricted","message":"privacy-restricted"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"privacy-restricted"},"message":{"type":"string","example":"privacy-restricted"},"details":{"type":"object","additionalProperties":true}}}},"description":"A current data-rights restriction prevents access or cancellation. No operation metadata, Location or X-Roblox-Operation-Id is returned."}}}},"429":{"description":"Rate limited. Wait at least the supplied Retry-After interval before polling or cancelling again.","headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait before retrying the operation request."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"rate_limit_exceeded","message":"Too Many Requests"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"rate_limit_exceeded"},"message":{"type":"string","example":"Too Many Requests"},"details":{"type":"object","additionalProperties":true}}}},"description":"Rate limited. Wait at least the supplied Retry-After interval before polling or cancelling again."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"internal_error","message":"Internal Server Error"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"internal_error"},"message":{"type":"string","example":"Internal Server Error"},"details":{"type":"object","additionalProperties":true}}}},"description":"Internal Server Error"}}}},"503":{"description":"Roblox operations are disabled or scheduling is temporarily unavailable","content":{"application/json":{"schema":{"type":"object","required":["error"],"example":{"error":{"code":"scheduler_disabled","message":"Roblox operations are not enabled"}},"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"scheduler_disabled means the asynchronous feature is off; scheduler-unavailable or roblox_scheduler_unavailable means the runtime is temporarily unavailable; scheduler-disabled means dispatch admission is disabled.","enum":["scheduler_disabled","scheduler-unavailable","scheduler-disabled","roblox_scheduler_unavailable"],"example":"scheduler_disabled"},"message":{"type":"string","example":"Roblox operations are not enabled"},"details":{"type":"object","additionalProperties":true}}}},"description":"Roblox operations are disabled or scheduling is temporarily unavailable"}}}}}}},"/v2/applications/templates":{"get":{"summary":"List application templates","tags":["Applications"],"description":"Returns one page of private community templates, including answer keys. Use a template definition with POST /applications to create an independent form.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"query","name":"cursor","required":false}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}}},"required":["id","name","definition"],"additionalProperties":false}},"nextCursor":{"type":["null","string"]}},"required":["items","nextCursor"]},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Save a community application template","tags":["Applications"],"description":"Saves reusable form content only. No credentials, responses, join requirements or open state are copied.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}}},"required":["name","definition"],"additionalProperties":false}}}},"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"201":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}}},"required":["id","name","definition"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/templates/{templateId}":{"delete":{"summary":"Delete a community application template","tags":["Applications"],"description":"Existing applications created from this template are unaffected.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"templateId","required":true}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/duplicate":{"post":{"summary":"Duplicate an application","tags":["Applications"],"description":"Creates an independent, closed version-1 form with a rollback-compatible creation audit. Password, responses and join requirements are excluded.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"201":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications":{"get":{"summary":"List application forms","tags":["Applications"],"description":"**Requires permission:** `applications.read` — View applications (Read application names, status, and configuration summaries.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit","required":false},{"schema":{"type":"string","maxLength":512},"in":"query","name":"cursor","required":false}],"x-required-permission":"applications.read","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt"],"additionalProperties":false}},"nextCursor":{"type":["null","string"]}},"required":["items","nextCursor"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"post":{"summary":"Create an application form","tags":["Applications"],"description":"Creates an audited form. Automatic grading requires Pro. Passwords and answer keys are never included in the audit summary.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}},"password":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["definition"],"additionalProperties":false,"example":{"definition":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}},"password":null}}}}},"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"201":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}":{"get":{"summary":"Read application metadata","tags":["Applications"],"description":"**Requires permission:** `applications.read` — View applications (Read application names, status, and configuration summaries.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.read","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"put":{"summary":"Update an application form","tags":["Applications"],"description":"Requires the current version. Publishes a new version and rollback-compatible audit entry. Omit password to keep it; null removes it.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}},"password":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["definition","version"],"additionalProperties":false,"example":{"definition":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}},"password":null,"version":1}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"delete":{"summary":"Delete an application form","tags":["Applications"],"description":"Requires the current version and no pending-join requirement. Historical responses are preserved.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["version"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/configuration":{"get":{"summary":"Read editable application configuration","tags":["Applications"],"description":"Includes answer keys for form management. Never returns the password or its hash.\n\n**Requires permission:** `applications.write` — Manage applications (Create, edit, or delete forms and read their answer keys.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.write","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"requiredForJoin":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"automaticGrading":{"type":"boolean"},"questionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"definition":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":2000},"enabled":{"type":"boolean"},"questions":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":0,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}},"correctOptionIds":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}},"required":["id","label","required","type","options","correctOptionIds"],"additionalProperties":false}]}},"grading":{"type":"object","properties":{"enabled":{"type":"boolean"},"passPercentage":{"type":"integer","minimum":1,"maximum":100}},"required":["enabled","passPercentage"],"additionalProperties":false}},"required":["name","description","enabled","questions","grading"],"additionalProperties":false,"example":{"name":"Community application","description":"Tell us why you would like to join. Never include personal information.","enabled":true,"questions":[{"id":"motivation","label":"Why would you like to join?","type":"long","required":true,"options":[],"correctOptionIds":[]}],"grading":{"enabled":false,"passPercentage":100}}}},"required":["id","name","description","version","enabled","requiredForJoin","passwordProtected","automaticGrading","questionCount","createdAt","updatedAt","definition"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/open":{"post":{"summary":"Open a form for a verified applicant","tags":["Applications"],"description":"Trusted servers must authenticate the player and supply their global Roblox user ID. Verification, restrictions, blacklists, and the form password are checked. Returns questions without answer keys.\n\n**Requires permission:** `applications.submit` — Submit applications (Open forms and submit responses on behalf of verified Roblox accounts.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"password":{"default":"","type":"string","maxLength":128}},"required":["userId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.submit","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"name":{"type":"string"},"description":{"type":"string"},"questions":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}}},"required":["id","label","required","type","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}}},"required":["id","label","required","type","options"],"additionalProperties":false}]}},"userId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"username":{"type":"string"},"existing":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","version","name","description","questions","userId","username","existing"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"503":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","content":{"application/json":{"schema":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/responses":{"post":{"summary":"Submit an application response","tags":["Applications"],"description":"Communities must obtain the member's explicit consent before submitting an application response on their behalf. Account verification and API access do not imply consent. One response per verified Roblox account per version. Enforces password, required answers, choice validity, and sensitive-information filtering. Does not accept a supplied grade or identity name.\n\n**Requires permission:** `applications.submit` — Submit applications (Open forms and submit responses on behalf of verified Roblox accounts.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"password":{"default":"","type":"string","maxLength":128},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"answers":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}]}},"required":["questionId","value"],"additionalProperties":false}}},"required":["userId","version","answers"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.submit","x-community-feature":"applications","responses":{"201":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"503":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","content":{"application/json":{"schema":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}},"get":{"summary":"List application responses","tags":["Applications"],"description":"**Requires permission:** `applications.responses.read` — View application responses (Read submitted answers, results, and private staff notes.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"default":25,"type":"integer","minimum":1,"maximum":100},"in":"query","name":"limit","required":false},{"schema":{"type":"string","maxLength":512},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","enum":["Pending","Passed","Failed"]},"in":"query","name":"status","required":false},{"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"in":"query","name":"userId","required":false},{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.responses.read","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt"],"additionalProperties":false}},"nextCursor":{"type":["null","string"]}},"required":["items","nextCursor"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/status":{"post":{"summary":"Read the latest result for a verified applicant","tags":["Applications"],"description":"Checks current form access and returns only the applicant result; no answers, keys, score, or staff notes.\n\n**Requires permission:** `applications.submit` — Submit applications (Open forms and submit responses on behalf of verified Roblox accounts.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"password":{"default":"","type":"string","maxLength":128}},"required":["userId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true}],"x-required-permission":"applications.submit","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"response":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt"],"additionalProperties":false},{"type":"null"}]}},"required":["response"]},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"503":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","content":{"application/json":{"schema":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/responses/{responseId}":{"get":{"summary":"Read an application response","tags":["Applications"],"description":"Includes submitted answers and private review notes. Excludes answer keys, Discord IDs, and password hashes.\n\n**Requires permission:** `applications.responses.read` — View application responses (Read submitted answers, results, and private staff notes.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"responseId","required":true}],"x-required-permission":"applications.responses.read","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"},"questions":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["short","long"]},"options":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}}},"required":["id","label","required","type","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":500},"required":{"type":"boolean"},"type":{"type":"string","enum":["single","multiple"]},"options":{"minItems":2,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label"],"additionalProperties":false}}},"required":["id","label","required","type","options"],"additionalProperties":false}]}},"answers":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$"}}]}},"required":["questionId","value"],"additionalProperties":false}},"score":{"type":["null","number"]},"reviewNote":{"type":"string"},"reviewedAt":{"type":["null","number"]}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt","questions","answers","score","reviewNote","reviewedAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}},"/v2/applications/{applicationId}/responses/{responseId}/review":{"post":{"summary":"Review a pending response","tags":["Applications"],"description":"Records a final pass or fail on behalf of the trusted API key. Requires the current revision. Optional feedback is shared with the applicant in their result notification; note remains staff-only. Already graded responses cannot be changed.\n\n**Requires permission:** `applications.responses.review` — Review application responses (Pass or fail pending application responses and record staff notes.)\n\n**Feature:** `applications`. Communities whose tier or trial does not include it receive 403.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["Passed","Failed"]},"note":{"default":"","type":"string","maxLength":2000},"feedback":{"default":"","type":"string","maxLength":2000}},"required":["revision","status"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid","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)$"},"in":"path","name":"responseId","required":true}],"x-required-permission":"applications.responses.review","x-community-feature":"applications","responses":{"200":{"description":"Application result","content":{"application/json":{"schema":{"description":"Application result","type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$"},"applicationId":{"type":"string","format":"uuid","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)$"},"applicationName":{"type":"string"},"applicationVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"userId":{"type":"number"},"username":{"type":"string"},"status":{"type":"string","enum":["Pending","Passed","Failed"]},"automaticGrading":{"type":"boolean"},"applicantFeedback":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"number"}},"required":["id","applicationId","applicationName","applicationVersion","userId","username","status","automaticGrading","applicantFeedback","revision","createdAt"],"additionalProperties":false},"meta":{"type":"object","additionalProperties":true}}}}}},"400":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"description":"The request was malformed or failed validation.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"401":{"description":"The API key is missing, malformed, or not recognised for this community.","content":{"application/json":{"schema":{"description":"The API key is missing, malformed, or not recognised for this community.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"403":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","content":{"application/json":{"schema":{"description":"The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"description":"The requested resource does not exist.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"409":{"description":"The request conflicts with current state.","content":{"application/json":{"schema":{"description":"The request conflicts with current state.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"429":{"description":"Rate limited.","content":{"application/json":{"schema":{"description":"Rate limited.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"500":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"description":"Unexpected server error.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}},"503":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","content":{"application/json":{"schema":{"description":"A required eligibility or identity restriction check is unavailable. Retry when the service recovers.","type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}}}}},"components":{"securitySchemes":{"BearerKey":{"type":"http","scheme":"bearer","description":"A `cl_live_` API key issued from the Dashboard. A key migrated from V2 is rejected here with 403 `legacy_key_unsupported`."},"ClanId":{"type":"apiKey","in":"header","name":"X-Clan-Id","description":"The community's ClanId."}},"schemas":{"RankSnapshot":{"type":"object","description":"Denormalised rank snapshot stored on the member.","required":["uniqueId","id","name","experience","locked"],"properties":{"uniqueId":{"type":"integer","description":"Roblox role resource id. 0 when unset.","example":900001},"id":{"type":"integer","description":"Roblox rank number, 0-255.","example":10},"name":{"type":"string","example":"Private"},"experience":{"type":"integer","description":"Experience required for this rank.","example":200},"locked":{"type":"boolean","description":"Whether AutoRank may move a member into this rank.","example":false}}},"Member":{"type":"object","required":["userId","username","experience","quotaPoints","medals","qualifications","currentRank","nextRank","perks","createdAt","lastUpdatedAt"],"properties":{"userId":{"type":"integer","description":"Global Roblox user id.","example":1234567},"username":{"type":"string","example":"PixelComet482"},"experience":{"type":"integer","example":250},"quotaPoints":{"type":"integer","example":3},"medals":{"type":"array","items":{"type":"string"},"description":"Medal names held by the member.","example":["Long Service"]},"qualifications":{"type":"array","items":{"type":"string"},"example":["Marksman"]},"currentRank":{"$ref":"#/components/schemas/RankSnapshot"},"nextRank":{"$ref":"#/components/schemas/RankSnapshot"},"perks":{"type":"object","required":["boosting","primary"],"properties":{"boosting":{"type":"boolean"},"primary":{"type":"boolean"}}},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"Rank":{"type":"object","required":["uniqueId","rankId","name","prefix","experience","locked","discordRoles","gamepass","badge","shirt","quota","createdAt","lastUpdatedAt"],"properties":{"uniqueId":{"type":"integer","description":"Roblox role resource id. This is what Open Cloud rank changes target.","example":900001},"rankId":{"type":"integer","description":"Roblox rank number, 0-255.","example":10},"name":{"type":"string","example":"Private"},"prefix":{"type":["null","string"],"example":"[PVT]"},"experience":{"type":"object","required":["enabled","requirement"],"properties":{"enabled":{"type":"boolean"},"requirement":{"type":"integer"}}},"locked":{"type":"boolean"},"discordRoles":{"type":"array","items":{"type":"string"}},"gamepass":{"type":"object","required":["enabled","id","name"],"properties":{"enabled":{"type":"boolean"},"id":{"type":["null","integer"]},"name":{"type":["null","string"]}}},"badge":{"type":"object","required":["enabled","id","name"],"properties":{"enabled":{"type":"boolean"},"id":{"type":["null","integer"]},"name":{"type":["null","string"]}}},"shirt":{"type":"object","required":["enabled","id","name","type"],"properties":{"enabled":{"type":"boolean"},"id":{"type":["null","integer"]},"name":{"type":["null","string"]},"type":{"type":["null","integer"]}}},"quota":{"type":"object","required":["enabled","points"],"properties":{"enabled":{"type":"boolean"},"points":{"type":"integer"}}},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"CatalogEntry":{"type":"object","description":"A medal or a qualification. The two share a shape.","required":["name","description","emote","discordRole","createdAt","lastUpdatedAt"],"properties":{"name":{"type":"string","example":"Long Service"},"description":{"type":"string","example":"Five years of service"},"emote":{"type":["null","string"],"example":":medal:"},"discordRole":{"type":["null","string"],"example":"1234567890123456789"},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"Blacklist":{"type":"object","required":["type","targetId","name","description","createdAt","lastUpdatedAt"],"properties":{"type":{"type":"string","enum":["User","Group"]},"targetId":{"type":"integer","description":"Roblox user id or group id, per `type`.","example":987654},"name":{"type":"string","example":"Troublemaker"},"description":{"type":"string","example":"Exploiting"},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"Actor":{"type":"object","description":"A Roblox user. `redacted` is true once an erasure request has removed the identity, in which case `id` is null.","required":["name","id","redacted"],"properties":{"name":{"type":"string","example":"PixelComet482"},"id":{"type":["null","integer"],"example":1234567},"redacted":{"type":"boolean","example":false}}},"Warning":{"type":"object","required":["warningId","target","invoker","severity","description","createdAt","lastUpdatedAt"],"properties":{"warningId":{"type":"integer","description":"Sequential per community.","example":1},"target":{"$ref":"#/components/schemas/Actor"},"invoker":{"$ref":"#/components/schemas/Actor"},"severity":{"type":"string","enum":["Low","Medium","High"]},"description":{"type":"string","example":"Failed to attend training"},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"Suspension":{"type":"object","required":["status","target","invoker","reason","durationMs","expiresAt","restoredAt","cancelledAt","previousRank","suspendedRank","createdAt","lastUpdatedAt"],"properties":{"status":{"type":"string","enum":["active","restored","cancelled"]},"target":{"$ref":"#/components/schemas/Actor"},"invoker":{"$ref":"#/components/schemas/Actor"},"reason":{"type":"string","example":"Misconduct"},"durationMs":{"type":"integer","example":86400000},"expiresAt":{"type":["null","integer"],"example":1735689600000},"restoredAt":{"type":["null","integer"]},"cancelledAt":{"type":["null","integer"]},"previousRank":{"type":"object","required":["uniqueId","id","name"],"properties":{"uniqueId":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}}},"suspendedRank":{"type":"object","required":["uniqueId","id","name"],"properties":{"uniqueId":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}}},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"EventParticipant":{"type":"object","required":["discordId","robloxId","robloxName"],"properties":{"discordId":{"type":["null","string"]},"robloxId":{"type":"integer","example":1234567},"robloxName":{"type":"string","example":"PixelComet482"}}},"EventType":{"type":"object","required":["id","name","quota","experience","defaultMentionRoleId"],"properties":{"id":{"type":"string","format":"uuid","example":"128d8545-92ce-46d5-9f04-6ed803bbd351"},"name":{"type":"string","example":"Training"},"quota":{"type":"object","required":["hostPoints","coHostPoints"],"properties":{"hostPoints":{"type":"integer","minimum":0},"coHostPoints":{"type":"integer","minimum":0}}},"experience":{"type":"object","required":["hostExperience","coHostExperience","attendeeExperience"],"properties":{"hostExperience":{"type":"integer","minimum":0},"coHostExperience":{"type":"integer","minimum":0},"attendeeExperience":{"type":"integer","minimum":0}}},"defaultMentionRoleId":{"type":["null","string"]}}},"EventLocation":{"type":"object","required":["placeId","universeId","name","groupId","groupName"],"properties":{"placeId":{"type":"integer","minimum":1},"universeId":{"type":"integer","minimum":1},"name":{"type":"string"},"groupId":{"type":"integer","minimum":1},"groupName":{"type":"string"}}},"Event":{"type":"object","required":["eventId","name","type","location","status","host","coHost","mentionRoleId","notes","attendees","proof","announcement","startedAt","finishedAt","cancelledAt","createdAt","lastUpdatedAt"],"properties":{"eventId":{"type":"string","format":"uuid","description":"Stable event identifier."},"name":{"type":"string"},"type":{"anyOf":[{"$ref":"#/components/schemas/EventType"},{"type":"null"}]},"location":{"type":"string","format":"uri"},"status":{"type":"string","enum":["Scheduled","Started","Finished","Cancelled"]},"host":{"$ref":"#/components/schemas/EventParticipant"},"coHost":{"anyOf":[{"$ref":"#/components/schemas/EventParticipant"},{"type":"null"}]},"mentionRoleId":{"type":["null","string"]},"notes":{"type":["null","string"]},"attendees":{"type":"array","items":{"$ref":"#/components/schemas/EventParticipant"}},"proof":{"anyOf":[{"type":"object","required":["channelId","messageId","attachmentId","filename","contentType","size"],"properties":{"channelId":{"type":"string"},"messageId":{"type":"string"},"attachmentId":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"size":{"type":"integer","minimum":0}}},{"type":"null"}]},"announcement":{"anyOf":[{"type":"object","required":["channelId","messageId"],"properties":{"channelId":{"type":"string"},"messageId":{"type":"string"}}},{"type":"null"}]},"startedAt":{"type":["null","integer"],"example":1735689600000},"finishedAt":{"type":["null","integer"],"example":1735689600000},"cancelledAt":{"type":["null","integer"],"example":1735689600000},"createdAt":{"type":["null","integer"],"example":1735689600000},"lastUpdatedAt":{"type":["null","integer"],"example":1735689600000}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable code.","example":"member_not_found"},"message":{"type":"string","example":"Member not found"},"details":{"type":"object","additionalProperties":true}}}}}}}}