Update Record

Update an existing custom record by record ID using template replacement values.

PATCH https://api.sonorancad.com/v2/general/records/{recordId}

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

Update a custom record using template replacement values.

Path Parameters

Name

Type

Description

recordId

integer

Record ID.

Request Body

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

Advanced integrations may provide a full record object instead of useDictionary, templateId, and replaceValues, but this is not recommended unless you need full control over the raw record payload. When an account target is needed for the update flow, use communityUserId by default, or provide roblox, discord, or accountUuid.

{
  "communityUserId": "player-1234",
  "useDictionary": true,
  "templateId": 12,
  "replaceValues": {
    "plate": "XYZ987"
  }
}

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

-- 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:updateRecordV2(501, {
    communityUserId = 'player-1234',
    useDictionary = true,
    templateId = 12,
    replaceValues = {
        ["plate"] = "XYZ987"
    },
  })

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

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the Lua export client:

local response = cad:updateRecordV2(501, {
    communityUserId = 'player-1234',
    useDictionary = true,
    templateId = 12,
    replaceValues = {
        ["plate"] = "XYZ987"
    },
  })

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

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.updateRecordV2(501, {
    communityUserId: 'player-1234',
    useDictionary: true,
    templateId: 12,
    replaceValues: {
      'plate': 'XYZ987',
    },
  });
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.updateRecordV2(501, {
    "communityUserId": 'player-1234',
    "useDictionary": True,
    "templateId": 12,
    "replaceValues": {
        "plate": "XYZ987"
    },
  })

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.updateRecordV2(
    451,
    new UpdateRecordV2Request
    {
        AccountUuid = "00000000-0000-0000-0000-000000000000",
        UseDictionary = true,
        RecordTypeId = 12,
        ReplaceValues = new Dictionary<string, string>
        {
            ["case_number"] = "SC-2026-002"
        }
    }
);

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Update Record"
  version: "1.0.0"
  description: "Update an existing custom record by record ID using template replacement values."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/general/records/{recordId}:
    patch:
      summary: "Update Record"
      operationId: "updateRecord"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                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"
      parameters:
        -
          description: "Record ID."
          name: "recordId"
          in: "path"
          schema:
            type: "integer"
          required: true
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              communityUserId: "player-1234"
              useDictionary: true
              templateId: 12
              replaceValues:
                plate: "XYZ987"
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request PATCH \
  --url "https://api.sonorancad.com/v2/general/records/451" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "communityUserId": "player-1234",
  "useDictionary": true,
  "templateId": 12,
  "replaceValues": {
    "plate": "XYZ987"
  }
}'

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"
        }
      ]
    }
  ]
}

PreviousCreate Record NextDelete Record

Last updated 1 month ago

Was this helpful?