New Character

This endpoint allows you to add a new character to an existing user account.

New Character

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

This endpoint allows you to add a new character to an existing user account.

Request Body

Name
Type
Description

id

string

Your community's ID

key

string

Your community's API Key

type

string

NEW_CHARACTER

data

array

Array of character objects

NEW CHARACTER ADDED TO {{ USERNAME }}
{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "NEW_CHARACTER",
    "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:

API Options for Adding and Modifying Records

Last updated

Was this helpful?