Sign inGet started

bird whatsapp mark-read

Usage

Code example
bird whatsapp mark-read <message-id> [flags]

Description

Mark a WhatsApp message as read
Mark one inbound WhatsApp message as read, optionally showing a typing indicator at the same time. Accepted asynchronously (202); there is no status to poll and no webhook.
Build the request from flags, a JSON WhatsAppReadReceiptRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example
# print the body shape (no credentials needed)
bird whatsapp mark-read --example

# the body it prints:
Code example
{
  "typing_indicator": true
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--typing-indicatorShow a typing indicator to the contact as well as marking the message read. WhatsApp clears it when you send your next message, or after 25 seconds, whichever comes first. Only ask for one if you are about to reply.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp getGet a WhatsApp message
bird whatsapp listList WhatsApp messages
bird whatsapp list-eventsList events for a WhatsApp message
bird whatsapp mediaDownload a received WhatsApp message's media
bird whatsapp previewPreview a WhatsApp message in the public builder
bird whatsapp sendSend a WhatsApp message to one recipient