/spaces/:id/presence

Add presence to a space

Log in to see full request history

Creates or extends an existing presence session for a user or device within a space. This endpoint should be polled on a set interval while the user is present in the space, using a TTL that is longer than that interval.

The response will either be 201 if the session is newly created or 200 if updated (extended).

🚧

Keep your presence intervals short

Presence should be posted at a heartbeat interval that is less than the provided TTL. Otherwise, undesired unique presence sessions will be created for every single post instead of properly extending a single session.

If this behavior is detected, the access token at fault for the abuse may be revoked.

Path Params
int32
required

The ID of the space to post presence to.

Body Params
int32

The ID of the user who is present.

string
required

The ID of the device reporting the presence. This parameter is only required if user_ref is omitted.

int32
Defaults to 30

How long to extend the presence session for, in seconds. If presence is posted with a TTL of 60 seconds and then again 120 seconds later, Robin will treat these as two separate sessions.

Responses

Language
Credentials
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json