Messages

Mark a conversation as read

Marks all unread incoming messages in the conversation as read.

For WhatsApp, this also sends read receipts (blue ticks) to the contact, EXCEPT on coexistence accounts (where the WhatsApp Business app on the customer's phone owns read state and we never override it).

For iMessage, this also marks the conversation read with the contact (1:1 conversations only). Best-effort.

This is the explicit, human-driven counterpart to GET .../messages, which is side-effect-free and does NOT mark anything read. Call this when a user actually views the conversation.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/inbox/conversations/{conversationId}/read

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/inbox/conversations/{conversationId}/read
  • Auth: HTTP bearer

Path parameters

conversationIdstring required

The conversation ID

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

accountIdstring required

Account ID

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.