Skip to the page

Praecise Platform

Rivier/ Reference/ inbox

Inbox presence heartbeat

post/workspace/inbox/threads/{id}/presence

Say the caller is viewing or replying to a conversation (repeat every 15 seconds); answers who else is.

Before you call

Credential: Authorization: Bearer $KEY
Scope: inbox:write
Graphql: Mutation.inboxPresenceHeartbeat
Sdk: inbox.presence.heartbeat
Cli: inbox presence heartbeat

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

kindstringrequired
One of: viewing, replying, idle.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/workspace/inbox/threads/{id}/presence' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "viewing"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown