Skip to content

Latest commit

 

History

History
90 lines (74 loc) · 2.93 KB

edit-character.md

File metadata and controls

90 lines (74 loc) · 2.93 KB
description
This endpoint allows you to update an existing character associated with an account in the CAD.

Edit Character

{% hint style="warning" %} This API endpoint requires the plus version of Sonoran CAD or higher. For more information, see our pricing page. {% endhint %}

{% hint style="danger" %} Characters can NOT be edited in communities using Database Sync, as all characters are pulled from your server's in-game database. {% endhint %}

{% swagger baseUrl="https://api.sonorancad.com" path="/civilian/edit_character" method="post" summary="Edit Character" %} {% swagger-description %} This endpoint allows you to update an existing character associated with an account in the CAD. {% endswagger-description %}

{% swagger-parameter in="body" name="id" type="string" %} Your community's ID {% endswagger-parameter %}

{% swagger-parameter in="body" name="key" type="string" %} Your community's API Key {% endswagger-parameter %}

{% swagger-parameter in="body" name="type" type="string" %} EDIT_CHARACTER {% endswagger-parameter %}

{% swagger-parameter in="body" name="data" type="array" %} Array of character objects {% endswagger-parameter %}

{% swagger-response status="200" description="A successful call will be met with the following response:" %}

CHARACTER {ID} EDITED FOR {USERNAME}

{% endswagger-response %}

{% swagger-response status="400" description="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

{% endswagger-response %}

{% swagger-response status="404" description="" %}

API ID NOT LINKED TO AN ACCOUNT IN THIS COMMUNITY

{% endswagger-response %} {% endswagger %}

{
    "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:

{% content-ref url="../general/custom-records/api-options-for-adding-and-modifying-records.md" %} api-options-for-adding-and-modifying-records.md {% endcontent-ref %}