Messages

Mark a conversation as read (send read receipt)

View as Markdown

Tells an account-owned Mac agent to open the conversation in Messages.app, which triggers an iMessage read receipt. Uses explicit from (must be owned by the account), else mapping, else any online agent owned by the account.

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Request

This endpoint expects an object.
fromstringOptional
Optional agent number. If omitted, it is resolved from the existing mapping.
tostringOptional

Recipient phone number (used as chat identifier for 1:1).

chatGuidstringOptional
Optional chat GUID for group or direct lookup.

Response

Read receipt queued
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error