Messages

Mark one received message as read

Flips read on the message, stamps dateRead, and recounts the thread's unreadCount (the dashboard badge clears at once). A sent or already-read message is a no-op (meta.markedRead: 0). If the user enabled "Mark read on Mac", their Mac also opens the thread in Messages.app in the background so the read receipt goes out over iMessage (meta.macSync: requested / off). Read-only keys get 403.

post/messages/{guid}/read

Request

  • Base URL: https://api.automessage.app/v1
  • URL: https://api.automessage.app/v1/messages/{guid}/read
  • Auth: API key in header X-API-KEY

Path parameters

guidstring required

Response

The message, now read, plus meta { conversationId, markedRead, unreadCount, macSync }.

guidstring required

Apple chat.db message GUID.

conversationstring required
bodystring required
outboundboolean required

True if we sent it.

contactstring

E.164 phone or email of the counterparty.

referencestring nullable

Message this replies to, if any.

deliveredAtstring date-time nullable
deliveredboolean nullable

Outbound only: chat.db is_delivered — a recipient device acknowledged it (connector 0.2.22).

deliveryErrorinteger nullable

Outbound only: Apple's non-zero message.error when Messages could not deliver it; the matching draft then has sendError "not_delivered…".

readAtstring date-time nullable
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.