Clear a conversation's unread backlog
mark_as_readMark a conversation's unread messages as read, without sending anything.
Set exactly one recipient: number, group_id, or contact_id.
This is independent of the automatic mark-as-read that already happens
when you send, reply, react, edit, delete or start typing (the number
also appears online first): use it to clear
an unread badge on its own, for example when handing a conversation to
a human who has already seen it. No message is sent and no message.*
event is produced, but the sender sees the messages as read (blue
ticks) on WhatsApp.
Needs a plan that includes read receipts (BUSINESS and above). Without
it this answers payment_required: feature_not_available, and the
answer will not change by retrying.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| number | No | Recipient phone number in E.164 form, digits only, country code first (e.g. `5511999999999`). Set exactly one of `number`, `group_id` or `contact_id`. | |
| group_id | No | Recipient group id (`grp_…`), from `list_groups`. A group id belongs to one number: an id from one inbox does not address the same group in another. Set exactly one of `number`, `group_id` or `contact_id`. Addressing a group needs a plan that includes group messaging: without it the call answers `payment_required: feature_not_available`, and retrying will not change that. | |
| contact_id | No | Recipient contact id (`ct_…`), from `list_contacts`. A contact id belongs to one number: an id from one inbox does not address the same person in another. Set exactly one of `number`, `group_id` or `contact_id`. | |
| number_alias | No | Which of the organization's WhatsApp numbers this acts on: `main`, the alias of an extra number, or the number's `id` (`num_…`), which stays the same when the alias is renamed. Call `list_numbers` to see them. Defaults to the main number. | main |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||