Title-Wide Data Management - Set Title Data And Overrides
Set and delete key-value pairs in a title data override instance.
POST https://titleId.playfabapi.com/Admin/SetTitleDataAndOverridesRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| KeyValues | True |
List of titleData key-value pairs to set/delete. Use an empty value to delete an existing key; use a non-empty value to create/update a key. |
|
| OverrideLabel |
string |
Name of the override. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Set |
Will set the given key values in the specified override or the primary title data based on whether the label is provided or not. |
|
Set |
|
|
Title |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
SetTitleDataAndOverridesRequest
Will set the given key values in the specified override or the primary title data based on whether the label is provided or not.
| Name | Type | Description |
|---|---|---|
| KeyValues |
List of titleData key-value pairs to set/delete. Use an empty value to delete an existing key; use a non-empty value to create/update a key. |
|
| OverrideLabel |
string |
Name of the override. |
SetTitleDataAndOverridesResult
TitleDataKeyValue
| Name | Type | Description |
|---|---|---|
| Key |
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 |
Error Codes
| Name | Code |
|---|---|
| DataLengthExceeded | 1146 |
| DuplicateKeys | 1509 |
| InvalidParams | 1000 |
| TooManyKeys | 1147 |