Add Blip

This endpoint allows you to add a new custom blip to your community's live map!

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

Add Blip

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

This endpoint allows you to add a custom blip to your live map.

Request Body

Name	Type	Description
id*	string	Your community's ID
key*	string	Your community's API Key
type*	string	ADD_BLIP
data*	array	Array of request objects

200 A successful call will be met with the following response:

// Blip object with ID set
[
    {
        "id": 1234,
        "coordinates": {
            "x": 0,
            "y": 0
        },
        "icon": "https://example.com/icon.png"
    }
]

400 The following 400 errors may be sent in response:

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

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "ADD_BLIP",
    "data": [
        {
            "serverId": 1, // Server ID
            "blip": {
                "id": -1, // New ID
                "subType": "Example", // Differentiate custom blips
                "coordinates": {
                    "x": 123,
                    "y": 456
                },
                "radius": 100, // Displays a circle radius
                "icon": "https://example.com/icon.png", // URL or Icon Name
                "color": "#df03fc", // Hex Color Code
                "tooltip": "Example added from the API!", // Blip Tooltip
                "data": [
                    {
                        "title": "Example 1",
                        "text": "123",
                    },
                    {
                        "title": "Example 2",
                        "text": "456",
                    }
                ]
            }
        },
    ]
}