Sign inGet Started

bird labels create

Usage

Code example
bird labels create <name> [flags]

Description

Create a label

Add a label to the workspace's catalogue with an optional #RRGGBB colour and a description of when to apply it. Names are unique regardless of case, and system names such as inbox, sent, unread, open and assigned are reserved. Creating a label fails once the workspace has 100.

Build the request from the <name> argument and flags, a JSON LabelCreate body via --body-file ("-" reads stdin), or both — an inline value 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 create --example

# the body it prints:
Code example
{
  "color": "#E5484D",
  "description": "Inbound sales enquiry from a company. Not support requests or vendors.",
  "name": "Hot 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
--colorThe label colour as a #RRGGBB hex value.
--descriptionWhen to apply the label. People and agents read it when they decide which label fits.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird labels deleteDelete a label
bird labels getGet a label
bird labels listList labels
bird labels updateUpdate a label

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