Skip to main content

​
Mark Messages as Read

Sends a WhatsApp read receipt (double blue tick) for the last inbound message of the conversation with to — marking that message and every earlier one as read without sending a message.
Best-effort: the request is accepted (200) even when there is nothing to confirm — check the acked field in the response.

​
Headers

  • Content-Type: application/json
  • x-api-key: ps_... (or x-api-key-id: <api_key_id>) — a number-scoped key

​
Body

​
string
required
Destination phone in E.164 or bare digits (e.g. +5511999999999 or 5511999999999) — the contact whose inbound messages to mark read.

​
Example

​
Response (200)

​
boolean
Always true when the request was accepted.
​
boolean
true when a read receipt was dispatched to the provider; false when there was nothing to confirm — see reason.
​
string
Present only when acked is false:
  • NO_INBOUND_MESSAGE — the conversation has no inbound message to acknowledge.
  • PII_RELAY_ONLY — the number’s privacy mode is RELAY_ONLY, so no inbound id is stored.

​
Provider behavior

​
Common errors