New Record

Sonoran CAD allows you to easily add new custom records and reports to your community via API.

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

New Record

POST https://api.sonorancad.com/general/new_record

This endpoint allows you to add a new custom record to your community.

Request Body

Name	Type	Description
id	string	Your community's ID
key	string	Your community's API Key
type	string	NEW_RECORD
data	array	Array of record objects

200

{NEW RECORD OBJECT}

400

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

    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "NEW_RECORD",
    "data": [
        {
            "user": "STEAM:1234",  // API ID or user UUID/GUID that 'owns' this record
            "useDictionary": true, // OPTION 1: Key/Value from template
            "recordTypeId": 7,     // OPTION 1: Custom template ID number
            "replaceValues": {
                // Field UID and Value
                "first": "Brian",
                "last": "Sosnowski"
            },
            "record": null,        // OPTION 2: Full raw JSON structure
        }
    ]
}

Formatting Data for Custom Records

Custom records can be easily modified with a set of key/value pairs, or full raw JSON.

Learn more about these formatting options below:

pageAPI Options for Adding and Modifying Records