Skip to content
RallyHere Docs

Update Player Presence Self

PATCH
/presence/v1/player/me/presence

Update the player’s online status and other presence data. If the player reports their online status as online or away, their “last_seen” presence info is updated. Player clients are expected to send requests to this endpoint on an interval of self_ping_interval_seconds. Otherwise they will be considered offline.

Authorizations

Parameters

Query Parameters

use_cache
boolean
default: true

Request Body required

object
status

Is the player currently online?

string
Allowed values: online away invisible offline
message

Optional custom message to display alongside the user’s online status. Leaving this unset will not change the value.

string
<= 256 characters
do_not_disturb

Disables notifications and invites. Leaving this unset will not change the value.

boolean
custom_data

Custom fields for the player to update about their presence. Custom data with a null value will be removed

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

Responses

200

Successful Response

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

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

500

Internal Server Error

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