bird labels update
Usage
Code example
bird labels update <label-id> [flags]Description
Update a label
Rename a label, or change or remove its colour or description. The label keeps its ID. The new name must not be in use in the workspace, regardless of case.
Build the request from flags, a JSON LabelUpdate 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 labels update --example
# the body it prints:Code example
{
"name": "Qualified lead"
}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 |
|---|---|
--name | The label name, unique in the workspace regardless of case. No commas, control characters, or leading or trailing whitespace. System names such as inbox, sent, unread, open or assigned are reserved. |
--color | The new colour, or null to remove it. |
--description | The new description, or null to remove it. |
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird labels create | Create a label |
bird labels delete | Delete a label |
bird labels get | Get a label |
bird labels list | List labels |
Related resources
Continue with the documentation, guides and examples for this topic.