Skip to main content

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.

Request​

Body

required

    status OnlineStatus (string)

    Possible values: [online, away, invisible, offline]

    An enumeration.

    message Message (string)

    Possible values: <= 256 characters

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

    do_not_disturb Do Not Disturb (boolean)

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

    custom_data

    object

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

    property name* string

Responses​

Successful Response

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.

Loading...