Skip to content

Mark the caller offline

POST
/v1/presence/offline
curl --request POST \
--url https://app.mondochat.io/v1/presence/offline \
--header 'Content-Type: application/json' \
--data '{ "hidden_ms": 31000, "session_token": "example-session-token" }'

Marks the caller offline when the page closes or has been hidden. It is public because a browser beacon cannot set headers: the session token travels in the body. hidden_ms is how long the page has been hidden, clamped to 0 to 60000, and last_seen_at becomes now minus it. Nothing happens while presence.enabled is off.

Errors: 401 unauthorized for an invalid session token.

Guide: Presence.

Media typeapplication/json
OfflineBeacon

The offline beacon: the session token and how long the page has been hidden.

object
hidden_ms
Hidden Ms

How long the page has been hidden; clamped to 0 to 60000.

integer
0
session_token
required
Session Token

The caller’s session token.

string
>= 1 characters <= 8192 characters

Successful Response

Problem

Media typeapplication/problem+json

An RFC 9457 problem: the body of every error answer.

object
code
required

The stable error code to branch on, such as policy_denied.

string
detail

What went wrong this time, when there is more to say.

string | null
errors

For validation, one entry per invalid field.

Array<object>

One invalid field.

object
loc

The path to the field.

array
msg

What is wrong with it.

string
instance

The path of the request.

string
reason

For policy_denied and limit_reached, the rule or limit that refused the request; for forbidden, a short cause such as you_blocked; for banned, temporary when the ban expires.

string
status
required

The HTTP status code.

integer
title
required

A short summary of the problem.

string
type
required

A URL that names the problem, https://app.mondochat.io/problems/<code>.

string

Example

{
"code": "policy_denied",
"detail": null,
"instance": "/v1/conversations/0199d6a0-2000-7000-8000-000000000001",
"reason": "pins",
"status": 403,
"title": "Policy denied",
"type": "https://app.mondochat.io/problems/policy_denied"
}