Skip to content
RallyHere Docs

Set Single Player Id Setting

Deprecated
PUT
/settings/v1/player/{player_id}/setting_type/{setting_type_id}/key/{key}

Update the value of a single player setting.

Required Permissions: setting:write for any player. setting:write:self for the player of the access token.

If Legacy types are enabled, to maintain compatibility with legacy applications, the following settings have special-case handling:

  • Setting Type case - Version 1 - key create - creates a new case set and returns the new key and data in the response.
  • Setting Type case - Version 1 - key is integer - Modify an existing case set. If it does not exist, a 404 response with the does_not_exist error code.
  • Setting Type loadout - Version 1 - key create - creates a new loadout and returns the new key and data in the response. All items keys will be given a new key
  • Setting Type loadout - Version 1 - key is integer - Modify an existing loadout. If it does not exist, a 404 response with the does_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.

DEPRECATED - Use the v2 endpoint instead. This endpoint will be removed in a future release.

Authorizations

Parameters

Path Parameters

player_id
required

Player to update setting for

integer

Player to update setting for

setting_type_id
required

Setting Type to update settings for. Must be one of the known setting types

string
>= 1 characters <= 128 characters

Setting Type to update settings for. Must be one of the known setting types

key
required

Setting Key to update setting for. Must conform to the setting type key format

string
>= 1 characters <= 256 characters

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
v
required

Setting Type Version to update setting for. Must be a valid version for the setting type

integer
value
required

New value for the setting. Must conform to the jsonschema defined for the setting type+version

Responses

200

Successful Response

object
key
additional properties

Setting version/value data from a specific setting type/key for a player

object
v
required

Setting Version

integer
value

Setting Value document

400

Error Codes:

  • setting_type_not_supported - The setting type is not supported at this time. Contact an administrator
  • setting_version_invalid - Setting Version is not valid for the provided type
  • update_not_enabled - Setting Type Version has updates disabled
  • setting_key_invalid - Setting Key does not meet requirements for that type/version
  • setting_value_invalid - Setting value failed validation against the jsonschema defined for the type/version. See response description for more details
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

  • setting_type_id_not_found - The setting type ID was not found
  • does_not_exist - Setting Key(s) do not exist - This will only occur for legacy setting types.
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string

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.
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string