kick-unit.md

description
This endpoint allows you to forcefully kick an active unit back to the community menu.

Kick Unit

{% hint style="warning" %} This API endpoint requires the standard version of Sonoran CAD or higher. For more information, see our pricing page. {% endhint %}

{% swagger baseUrl="https://api.sonorancad.com" path="/emergency/kick_unit" method="post" summary="Kick Unit" %} {% swagger-description %} This endpoint allows you to forcefully kick an active unit back to the community menu. {% endswagger-description %}

{% swagger-parameter in="body" name="id" type="string" %} Your community's ID {% endswagger-parameter %}

{% swagger-parameter in="body" name="key" type="string" %} Your community's API Key {% endswagger-parameter %}

{% swagger-parameter in="body" name="type" type="string" %} KICK_UNIT {% endswagger-parameter %}

{% swagger-parameter in="body" name="data" type="array" %} Array of unit status objects {% endswagger-parameter %}

{% swagger-response status="200" description="A successful call will be met with the following response:" %}

UNIT KICKED

{% endswagger-response %}

{% swagger-response status="400" description="The following 400 errors may be sent in response:" %}

INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY

{% endswagger-response %} {% endswagger %}

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "KICK_UNIT",
    "data": [
        {
            "apiId": "STEAM:1234", // API ID entered in the unit identifiers
                                   // Typically, this is their STEAM ID
            "reason": "Automated AFK Timer", // "You have been kicked for {REASON}"
            "serverId": 1
        },
    ]
}