bird amb conversations update

Usage

Code example

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

Updates assignment, labels and read state on a workspace conversation. Omitted fields stay unchanged; null assigned_to unassigns, empty labels clears labels, and read false has no effect. This operation does not close or reopen a conversation.

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

Code example

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

# the body it prints:

Code example

{
  "assigned_to": "usr_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 null to unassign it.
--labels <value>…	Replaces the full set of labels on this conversation. Pass an empty array to clear every label.
--read	Set to true to mark this conversation read, resetting unread_count to zero. There is no way to mark a conversation unread through this field; false has no effect.
--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

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integration Implementation guideSend your first email

Get an implementation brief