Sign inGet Started

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

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--nameThe 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.
--colorThe new colour, or null to remove it.
--descriptionThe new description, or null to remove it.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird labels createCreate a label
bird labels deleteDelete a label
bird labels getGet a label
bird labels listList labels

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