[BETA] subscribe to and fetch current presence of a chat

Subscribes to presence updates for the given chat and returns the current state. Subsequent changes emit presence_update webhook events (if enabled in webhook settings).

Important — subscription model:

  • Presence in Web is subscription-based. You MUST call this action at least once per chat you want to track. Without a subscribe, the presence_update webhook never fires for that chat.
  • Calling this action again acts as a renewal. Subscriptions are lost on instance reconnect — re-subscribe after any 'ready' event if you want continuous tracking.
  • Privacy reciprocity: if the instance account hides its own last-seen in the settings, it cannot read others' last-seen either. Expect deny:true or hasData:false in that case.
  • High-frequency event — a single active chat can produce 10+ presence_update webhooks per minute. Debounce on your side.
  • Groups: chatstate is always null. Use typingParticipants and recordingParticipants instead. isOnline on a group = 'at least one member online'.

Note: This endpoint is currently in beta and may change without notice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params
string
required

Chat ID <countrycode_short>@c.us or @g.us for groups

boolean
Defaults to true

If true, wait for the first server push before returning (up to timeoutMs). If false, return immediately — the returned presence.hasData may be false.

integer
Defaults to 1500

Maximum milliseconds to wait for the first server push when waitForData is true.

Responses

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json