`bird amb conversations update`

Usage

Esempio di codice

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

Updates assignment, labels, inbox status, queue and shared workspace read state, or settles a pending routing_change. Omitted fields stay unchanged; null assigned_to unassigns, empty labels clears labels and null queue leaves the conversation unrouted. Pass read as a date-time to acknowledge received inbound messages through that timestamp. Settle a pending change with routing_change {action, message_id}, copying message_id from the conversation's routing_change: apply adopts the newer group, intent and queue, dismiss keeps the current routing, and a 409 means the change was replaced or settled first. Resolving or reopening inbox work preserves the Apple channel state and sending restrictions.

Build the request from flags, a JSON AMBConversationUpdate 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

Esempio di codice

# print the body shape (no credentials needed)
bird amb conversations update --example

# the body it prints:

Esempio di codice

{
  "assigned_to": "me",
  "inbox_status": "open",
  "labels": ["billing", "vip"],
  "queue": "billing",
  "routing_change": {
    "action": "dismiss",
    "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

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.
`--queue`	Queue to move the conversation to, or null to leave it unrouted. Routing rules do not run, and the conversation keeps its group and intent. Moving the queue clears any pending routing_change, and cannot be combined with an apply decision.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird amb conversations get`	Get a conversation
`bird amb conversations list`	List conversations
`bird amb conversations list-messages`	List messages in a conversation
`bird amb conversations typing`	Send a typing indicator

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione

Risorse correlate