Cancel Session

This endpoint allows you to cancel the current session for the specified server ID.

API endpoint requires the FREE version of Sonoran CMS or higher. For more information, see our pricing page.

Cancel Session

POST https://api.sonorancms.com/sessions/cancel

Cancel the current session for the specified server ID.

Request Body

Name	Type	Description
id*	string	Community ID
key*	string	API Key
type*	string	CANCEL_SESSION
data*	array	Array of request objects

200: OK

{
    "id": "UUID_OF_SESSION",
    "sysStatus": true,
    "community": "YOUR_COMMUNITY_ID",
    "serverId": 1,
    "startedBy": "UUID_OF_SESSION_STARTER",
    "startedAt": "TIMESTAMPTZ_STRING",
    "endedBy": null,
    "endedAt": null,
    "cancelledBy": "UUID_OF_SESSION_CANCELLER",
    "stats": {},
    "metadata": {},
}

400: Bad Request The following 400 errors may be sent in response:

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "CANCEL_SESSION",
    "data": [
        {
            "serverId": 1,
            "accId": "ACCID_OF_USER_CANCELLING_SESSION",
        }
    ]
}