Skip to content
RallyHere Docs
GitHub

Delete Single Player Uuid Setting

DELETE
/settings/v2/player/{player_uuid}/setting_type/{setting_type_id}/key/{key}

Delete a single player setting

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

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

player_uuid
required

Player to delete setting for

string format: uuid

Player to delete setting for

setting_type_id
required

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

string
>= 1 characters <= 128 characters

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

key
required

Setting Key to delete setting for

string
>= 1 characters <= 256 characters

Setting Key to delete setting for

Responses

200

Successful Response

400

Error Codes:

  • setting_type_not_supported - The setting type is not supported at this time. Contact an administrator
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
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