Skip to content
Clan LabsAPIv2
GuidesWebsite Open dashboard
OverviewAuthenticationAPI keysRequestsErrorsMigrationEndpoints
API reference
API v2
  • API overview
  • Authentication
  • API keys and scopes
  • Requests and responses
  • Errors and rate limits
  • Versioning and migration
  • Swagger migration
Troubleshooting
  • Authentication failures
  • Request and rate-limit errors
Members
  • GETList members
  • GETFetch one member
  • POSTChange a member's experience
  • POSTChange a member's quota points
  • PUTSet a member's rank
  • POSTPromote a member one rank
  • POSTDemote a member one rank
  • POSTAward a medal
  • DELETERemove a medal
  • POSTAward a qualification
  • DELETERemove a qualification
  • GETList a member's suspensions
  • POSTSuspend a member
  • POSTRestore a member's active suspension
  • POSTCancel a member's active suspension
Configuration
  • GETList ranks
  • GETFetch one rank
  • GETList medals
  • GETFetch one medal by name
  • GETList qualifications
  • GETFetch one qualification by name
Moderation
  • GETList blacklist entries
  • POSTCreate a blacklist entry
  • GETFetch one blacklist entry
  • PATCHUpdate a blacklist entry's description
  • DELETERemove a blacklist entry
  • GETList warnings
  • POSTIssue a warning
  • GETFetch one warning
  • PATCHUpdate a warning
  • DELETEDelete a warning
Events
  • GETList events
  • POSTCreate and announce an event
  • GETList curated event types
  • GETList approved event locations
  • GETFetch one event
  • POSTCancel an event
  • POSTFinish an event
  • POSTCreate a fresh Discord announcement
GuidesClan Labs websiteOpen dashboard Support
API v2
  • API overview
  • Authentication
  • API keys and scopes
  • Requests and responses
  • Errors and rate limits
  • Versioning and migration
  • Swagger migration
Troubleshooting
  • Authentication failures
  • Request and rate-limit errors
Members
  • GETList members
  • GETFetch one member
  • POSTChange a member's experience
  • POSTChange a member's quota points
  • PUTSet a member's rank
  • POSTPromote a member one rank
  • POSTDemote a member one rank
  • POSTAward a medal
  • DELETERemove a medal
  • POSTAward a qualification
  • DELETERemove a qualification
  • GETList a member's suspensions
  • POSTSuspend a member
  • POSTRestore a member's active suspension
  • POSTCancel a member's active suspension
Configuration
  • GETList ranks
  • GETFetch one rank
  • GETList medals
  • GETFetch one medal by name
  • GETList qualifications
  • GETFetch one qualification by name
Moderation
  • GETList blacklist entries
  • POSTCreate a blacklist entry
  • GETFetch one blacklist entry
  • PATCHUpdate a blacklist entry's description
  • DELETERemove a blacklist entry
  • GETList warnings
  • POSTIssue a warning
  • GETFetch one warning
  • PATCHUpdate a warning
  • DELETEDelete a warning
Events
  • GETList events
  • POSTCreate and announce an event
  • GETList curated event types
  • GETList approved event locations
  • GETFetch one event
  • POSTCancel an event
  • POSTFinish an event
  • POSTCreate a fresh Discord announcement
  1. API reference
  2. /
  3. Moderation
API v2 · Moderation

Issue a warning

POST/v2/warnings
Last updated 3 September 2026

Overview

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.

Permission scope
warnings.write
Community feature
warnings
Content type
application/json

Authentication

Two headers are required

Send a current cl_live_… key as a Bearer token and the community’s Clan ID separately.

Authorization: Bearer YOUR_API_KEY
X-Clan-Id: COMMUNITY_ID

The key must be enabled, the community API master switch must be on, and the key must include warnings.write.

Parameters

This endpoint has no path or query parameters.

Request body

A JSON request body is required.

Exactly one of these field sets is required: targetUserId or targetUsername.

FieldTypeRequiredConstraints and description
targetUserIdintegerConditionalmin 1, max 9007199254740991
targetUsernamestringConditionalmin length 3, max length 20
severityLow | Medium | HighYes—
descriptionstringYesmin length 1, max length 1024
invokerUserIdintegerNomin 1, max 9007199254740991
invokerUsernamestringNomin length 3, max length 20

Error responses

StatusWhen it is returned
400The request was malformed or failed validation.
401The API key is missing, malformed, or not recognised for this community.
403The key is disabled, lacks the required permission, or the community's subscription or tier does not cover API access or this feature.
404The requested resource does not exist.
409The request conflicts with current state.
429Rate limited.
500Unexpected server error.
Handle error codes, not prose
Error bodies use error.code as the stable machine-readable value. The message is for people and may become clearer over time.

Rate limits

This endpoint shares the API key’s configured request budget. A 429 response includes a Retry-After header and limit, remaining, and resetMs values in error.details. Wait for the indicated interval before retrying.

Related endpoints

GETList blacklist entries/v2/blacklistsPOSTCreate a blacklist entry/v2/blacklistsGETFetch one blacklist entry/v2/blacklists/{type}/{id}PATCHUpdate a blacklist entry's description/v2/blacklists/{type}/{id}

Examples use placeholders. Never put an API key in source control, a Roblox place file, screenshots, or support messages.

PreviousList warningsNext Fetch one warning
Server-side examples

After HTTP requests are enabled, Roblox Lua uses HttpService:GetSecret() from a server Script, never a LocalScript.

Request

POST
curl --request POST \
  --url 'https://v3.api.clanlabs.co/v2/warnings' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'X-Clan-Id: COMMUNITY_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetUserId": 1,
  "severity": "Low",
  "description": "YOUR_DESCRIPTION"
}'

Response

201

The issued warning

{
  "data": {
    "warningId": 1,
    "target": {
      "name": "Builderman",
      "id": 1234567,
      "redacted": false
    },
    "invoker": {
      "name": "Builderman",
      "id": 1234567,
      "redacted": false
    },
    "severity": "Low",
    "description": "Failed to attend training",
    "createdAt": 1735689600000,
    "lastUpdatedAt": 1735689600000
  }
}