`bird email threads update`

Usage

Code example

bird email threads update <thread-id> [flags]

Description

Update a thread

Use --folder to move a thread and --read=true or --read=false to change read state. Use delete to trash a thread and restore before changing a trashed thread's folder. Labels are custom labels only.

Build the request from flags, a JSON EmailThreadUpdateRequest 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 email threads update --example

# the body it prints:

Code example

{
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "folder": "inbox",
  "labels": {
    "add": ["urgent"],
    "remove": ["pending"]
  }
}

Options

Labels

Name	Description
`--add-label <value>…`	Custom label to add; repeatable.
`--remove-label <value>…`	Custom label to remove; repeatable.

Metadata

Name	Description
`--contact-id`	Contact id to link to this conversation

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
`--read`	Mark the thread read (true) or unread (false).
`--folder`	Destination folder: inbox, archive or spam. Use delete to trash and restore to recover.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird email threads delete`	Delete a thread
`bird email threads get`	Get a thread
`bird email threads list`	List threads
`bird email threads restore`	Restore a thread from trash
`bird email threads search`	Search threads

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

Try the practice and get an implementation brief

Related resources