`bird whatsapp conversations update`

Usage

Code example

bird whatsapp conversations update <conversation-id> [flags]

Assign a WhatsApp conversation, change its inbox status, mark received messages read, or replace its labels. assigned_to takes a user ID, me, or a JSON null to unassign. labels is the full set, so send every label you want to keep. Labels do not affect read state. It does not move control between the Meta Business Agent and your workspace.

Build the request from flags, a JSON WhatsAppConversationUpdateRequest 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 conversations update --example

# the body it prints:

Code example

{
  "labels": ["billing"]
}

Options

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--assigned-to`	User to assign this conversation to. Pass a workspace member's user ID, me for the signed-in user, or null to unassign it. An API key cannot use me and receives a 422 response.
`--inbox-status`	Whether the conversation needs attention in the workspace inbox. Set it to resolved when the work is finished. A new inbound message reopens the same conversation. Changing inbox status preserves message history and does not change the channel's permission to send messages or mark messages read. Possible values: open, resolved.
`--labels <value>…`	Labels chosen by your workspace. On update, this replaces the full set; pass an empty array to clear every label. Labels do not change read state or inbox status. Each label must contain 1 to 64 characters, with no commas, control characters, or leading or trailing whitespace. Duplicate labels are rejected. The names all, archived, assigned, closed, deleted, draft, drafts, flagged, important, inbox, junk, muted, none, open, pinned, read, snoozed, spam, starred, trash, and unread are reserved in every casing.
`--read`	Mark received inbound messages with created_at at or before this timestamp as read in the shared workspace inbox. Messages sharing the timestamp are included together. Later arrivals remain unread until another read update. This does not send a read receipt to the customer or change inbox status. Omit to leave read state unchanged.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird whatsapp conversations counts`	Get WhatsApp conversation counts
`bird whatsapp conversations get`	Get a WhatsApp conversation
`bird whatsapp conversations get-message`	Get a message in a WhatsApp conversation
`bird whatsapp conversations list`	List WhatsApp conversations
`bird whatsapp conversations list-events`	List WhatsApp conversation events
`bird whatsapp conversations list-messages`	List messages in a WhatsApp conversation

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources