Modify Identifier

This endpoint allows you to add, edit, or remove unit identifiers.

This API endpoint requires the Pro version of Sonoran CAD or higher. For more information, see our pricing page.

Modify Identifier

POST https://api.sonorancad.com/emergency/modify_identifiers

This endpoint allows you to retrieve all unit identifiers for a specified account in your community.

Request Body

NameTypeDescription

id*

string

Your community's ID

key*

string

Your community's API Key

type*

string

MODIFY_IDENTIFIER

data*

array

Array of request objects

// ADD or EDIT
{
    // Unit Identifier Object
}

// REMOVE
"Identifier 123 removed!"
{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "MODIFY_IDENTIFIER",
    "data": [
        {
            "apiId": "Steam:1234", // (OPTION 1): Generally the Steam HEX
            "account": "000-000-000", // (OPTION 2): Sonoran Account UUID
            "action": 0, // ADD
            "identifier": {
                // OPTIONAL: Only for ADD & EDIT actions
                // Identifier/unit object
            },
            "identId": 123 // OPTIONAL: Only for REMOVE action
        }
    ]
}

Action Enum

The action property is an enumerator value with the following values:

Enum (Int)Description

0

ADD

1

EDIT

2

REMOVE

Last updated