Endpoint description

Broadcast a message to all connected players

Endpoint route

POST

/api/v1/chat/broadcast/players

Response type

Application/Json

Header parameters

KeyValueTypeRequired
AuthorizationBasic [key]stringFor Basic authentication mode only
Authorization[key]stringFor Key-Basic and Key-Advanced authentication modes only

Query Parameters

No parameters

Body parameters

{
    "message": string
}

Access rights

Authentication typeKey typeAllowed
Openfalse
Basicfalse
Key-Basicfalse
Key-AdvancedPublic keyfalse
Key-AdvancedProtected keyfalse
Key-AdvancedAdmin keyfalse

Success response

{
    "success": bool,
    "code": int,
    "message": string
}

Error response

{
    "success": bool,
    "code": int,
    "message": string
}

Return codes

HTTP CodeType
200OK
400Bad Request
401Unauthorized
403Forbidden