bird email threads update
Usage
Code example
bird email threads update <thread-id> [flags]Description
Update a thread
System labels move a conversation: add "archive" to file it away, add "spam" to file it as spam, add "inbox" (or remove "spam", "blocked", or "archive") to return it to the inbox. Remove "unread" to mark all retained received messages as read; remove "blocked" to unblock the sender. To block a sender going forward, add a rule with bird email mailboxes receive-rules create.
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",
"labels": {
"add": ["urgent"],
"remove": ["pending"]
}
}Options
Labels
| Name | Description |
|---|---|
| --add-label <value>… | Label to add; repeatable. System labels: inbox, archive, spam |
| --remove-label <value>… | Label to remove; repeatable. System labels: inbox, archive, spam, blocked, unread |
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 |
|---|---|
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird email threads delete | Delete a thread |
| bird email threads get | Get a thread |
| bird email threads list | List threads |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideGetting started with emailExplore the capabilityEmailFollow the learning pathBuild your first integrationImplementation guideSend your first email
Try the practice and get an implementation brief