Create Record

Create a new custom record using template replacement values.

POST https://api.sonorancad.com/v2/general/records

Rate limit: 30 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Create a custom record for a target account.

Request Body

Use communityUserId by default, or provide exactly one of roblox, discord, or accountUuid as the target user.

The recommended path is to set useDictionary to true, provide the target recordTypeId, and pass replaceValues keyed by the template field placeholders. This avoids building the full record section and field structure yourself.

Advanced integrations may provide a full record object instead of useDictionary, recordTypeId, and replaceValues, but this is not recommended unless you need full control over the raw record payload.

This endpoint is also used to create civilian characters. The key difference is which template recordTypeId you submit.

Choosing a recordTypeId

Use GET /v2/general/templates first if you need to inspect the templates available in your community.

Some built-in template families use fixed IDs from the backend, while custom templates keep the community-specific recordTypeId shown by the templates endpoint.

Record kind	type	recordTypeId to use	Notes
Character	7	7	Creates a civilian character for the target account.
Warrant	2	2	Built-in required type.
BOLO	3	3	Built-in required type.
License	4	4	Built-in required type.
Vehicle Registration	5	5	Built-in required type.
Custom Police Record	8	Community template ID	Check GET /v2/general/templates.
Custom Police Report	9	Community template ID	Check GET /v2/general/templates.
Custom Medical Record	10	Community template ID	Check GET /v2/general/templates.
Custom Medical Report	11	Community template ID	Check GET /v2/general/templates.
Custom Fire Record	12	Community template ID	Check GET /v2/general/templates.
Custom Fire Report	13	Community template ID	Check GET /v2/general/templates.
Custom DMV Record	14	Community template ID	Check GET /v2/general/templates.
Custom Lawyer Record	15	Community template ID	Check GET /v2/general/templates.
Custom Lawyer Report	16	Community template ID	Check GET /v2/general/templates.

If you are creating a character, send the character template ID (7) or the raw character record payload with type: 7. For anything else, use the template ID returned by the templates endpoint for that record.

Character Example

This example creates a civilian character for the target user by selecting the built-in character template:

{
  "communityUserId": "player-1234",
  "useDictionary": true,
  "recordTypeId": 7,
  "replaceValues": {
    "first": "John",
    "last": "Doe",
    "dob": "01/01/1995"
  }
}

For a non-character custom record, the same endpoint looks like this:

{
  "communityUserId": "player-1234",
  "useDictionary": true,
  "recordTypeId": 12,
  "replaceValues": {
    "plate": "ABC123"
  }
}

If you need to submit a fully assembled record, you can provide record instead. This is an advanced option and is not recommended for most integrations:

{
  "communityUserId": "player-1234",
  "record": {
    "type": 9,
    "name": "Incident Report",
    "sections": []
  }
}

Example Request

Sonoran.lua

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:createRecordV2({
    communityUserId = 'player-1234',
    useDictionary = true,
    recordTypeId = 12,
    replaceValues = {
        ["case_number"] = "SC-2026-001"
    },
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

SonoranCADFiveM

Sonoran.js

Sonoran.py

Sonoran.Net

OpenAPI

cURL

Response

Successful requests return application/json.

{
  "recordTypeId": 12,
  "id": 451,
  "name": "Incident Report",
  "type": 9,
  "sections": [
    {
      "category": 0,
      "label": "Report Details",
      "fields": [
        {
          "label": "Case Number",
          "value": "SC-2026-001",
          "uid": "case_number"
        }
      ]
    }
  ]
}