Skip to content

Put Player Deserter

PUT
/session/v1/player/{player_uuid}/deserter/{deserter_id}

Update a specific player’s deserter status

Authorizations

Parameters

Path Parameters

deserter_id
required
string
player_uuid
required
string format: uuid

Request Body required

object
deserter_expiration
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
deserter_count
required

The number of times a player has deserted before the expiration

integer
custom_data

Custom data about a players desertion status

object
key
additional properties
string
>= 1 characters <= 4096 characters

Responses

200

Successful Response

object
deserter_id
required

ID for which type of deserter this is

string
deserter_status
required

Flag of whether or not the player is a deserter

boolean
deserter_expiration

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
deserter_count

The number of times a player has deserted before the expiration

integer
last_updated

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
custom_data

Custom data about a players desertion status

object
key
additional properties
string
>= 1 characters <= 4096 characters

403

Forbidden

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