Set Single Player Uuid Setting
PUT /settings/v2/player/{player_uuid}/setting_type/{setting_type_id}/key/{key}
Update the value of a single player setting document.
Required Permissions:
-
For any player (including themselves) any of:
setting:*:*
,setting:write
-
For the player themselves :
setting:write:self
If Legacy types are enabled, to maintain compatibility with legacy applications, the following settings have special-case handling:
- Setting Type
case
- Version1
- keycreate
- creates a new case set and returns the new key and document in the response. - Setting Type
case
- Version1
- key is integer - Modify an existing case set. If it does not exist, a 404 response with thedoes_not_exist
error code. - Setting Type
loadout
- Version1
- keycreate
- creates a new loadout and returns the new key and document in the response. All items keys will be given a new key - Setting Type
loadout
- Version1
- key is integer - Modify an existing loadout. If it does not exist, a 404 response with thedoes_not_exist
error code. When modifying loadout items, item keys that convert into integers/longs are treated as updates (and will error the update if they are not valid), all others are treated as creates and will be given a new key.
Authorizations
Parameters
Path Parameters
Player to update setting for
Player to update setting for
Setting Type to update settings for. Must be one of the known setting types
Setting Type to update settings for. Must be one of the known setting types
Setting Key to update setting for. Must conform to the setting type key format
Setting Key to update setting for. Must conform to the setting type key format
Request Body required
Updatable contents of a setting for a player
object
Setting Type Version to update setting for. Must be a valid version for the setting type
New value for the setting. Must conform to the jsonschema defined for the setting type+version
Responses
200
Successful Response
object
Setting version/value data from a specific setting type/key for a player
object
Setting Version
Setting Value document
400
Error Codes:
setting_type_not_supported
- The setting type is not supported at this time. Contact an administratorsetting_version_invalid
- Setting Version is not valid for the provided typeupdate_not_enabled
- Setting Type Version has updates disabledsetting_key_invalid
- Setting Key does not meet requirements for that type/versionsetting_value_invalid
- Setting value failed validation against the jsonschema defined for the type/version. See response description for more details
object
403
Error Codes:
auth_invalid_key_id
- Invalid Authorization - Invalid Key ID in Access Tokenauth_invalid_version
- Invalid Authorization - versionauth_malformed_access
- Invalid Authorization - malformed access tokenauth_not_jwt
- Invalid Authorizationauth_token_expired
- Token is expiredauth_token_format
- Invalid Authorization - {}auth_token_invalid_claim
- Token contained invalid claim value: {}auth_token_invalid_type
- Invalid Authorization - Invalid Token Typeauth_token_sig_invalid
- Token Signature is invalidauth_token_unknown
- Failed to parse tokeninsufficient_permissions
- Insufficient Permissions
object
404
Error Codes:
setting_type_id_not_found
- The setting type ID was not founddoes_not_exist
- Setting Key(s) do not exist - This will only occur for legacy setting types.
object
422
Validation Error
object
object
500
Error Codes:
setting_type_version_schema_invalid
- Setting type/version jsonschema is invalid and could not be used to validate the setting value. See response description for more details.