Documentation

SetTitleData

Creates and updates the key-value store of custom title settings which can be read by the client

Request Details

This API method is designed to store title specific values which can be read by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. This operation is additive. If a Key does not exist in the current dataset, it will be added with the specified Value. If it already exists, the Value for that key will be overwritten with the new Value.

SetTitleDataRequest
Request Properties
Key (required) String

key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.

Value String

new value to set. Set to null to remove a value

POST https://{{TitleID}}.playfabapi.com/Admin/SetTitleData
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Key": "Running Speed",
  "Value": "1.03"
}
        

Response Details

SetTitleDataResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
DataLengthExceeded 1146
TooManyKeys 1147