Edit Character

This endpoint allows you to update an existing character associated with an account in the CAD.

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

Characters can NOT be edited in communities using Database Sync, as all characters are pulled from your server's in-game database.

Edit Character

POST https://api.sonorancad.com/civilian/edit_character

This endpoint allows you to update an existing character associated with an account in the CAD.

Request Body

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

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

CHARACTER {ID} EDITED FOR {USERNAME}

400 The following 400 errors may be sent in response:

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

404

API ID NOT LINKED TO AN ACCOUNT IN THIS COMMUNITY

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "EDIT_CHARACTER",
    "data": [
        {
            "user": "STEAM:1234",  // API ID or user UUID/GUID that 'owns' this record
            "templateId": 5,       // Template ID (shown in Admin menu next to name) or on the record's `recordTypeId` field
            "useDictionary": true, // OPTION 1: Key/Value from template
            "recordId": 123,       // OPTION 1: Record ID being modified
            "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:

API Options for Adding and Modifying Records