---
title: "Create a label"
canonical: "https://bird.com/docs/api/reference/create-label"
---

# Create a label

`POST /v1/labels`

Adds a label to the workspace's catalogue. Give it a description of when
to apply it, so people and agents label conversations the same way.

Names are unique in the workspace regardless of case; a name already in
use returns a conflict error. System names such as `inbox`, `sent`,
`unread`, `open` and `assigned` are reserved. Creating a label fails once
the workspace has 100 labels.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

## Code samples

**TypeScript**

```ts
const label = await bird.labels.create({
  name: "refund-request",
  color: "#E5484D",
  description: "The customer asks for their money back.",
});
console.log(label.id);
```

Examples: [TypeScript](/docs/api/reference/create-label.ts.md) · [Python](/docs/api/reference/create-label.py.md) · [Go](/docs/api/reference/create-label.go.md) · [PHP](/docs/api/reference/create-label.php.md) · [CLI](/docs/api/reference/create-label.cli.md) · [MCP](/docs/api/reference/create-label.mcp.md) · [cURL](/docs/api/reference/create-label.curl.md)

## Example response `201`

```json
{
  "id": "lbl_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Hot lead",
  "color": "#E5484D",
  "description": "Inbound sales enquiry from a company. Not support requests or vendors.",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}
```

## Header parameters

- `Idempotency-Key` (string, optional)

  Client-supplied key. On operations supporting request deduplication, a retained
  response is replayed for duplicate requests with the same key within the
  idempotency window (3 hours by default). This protection requires a workspace,
  organization, or staff-account scope. User-only and unscoped unauthenticated operations,
  streams, and operations with a separate replay contract do not use this
  response replay.

  On a supported operation, if idempotency protection is unavailable before execution, the API returns
  `503 IdempotencyUnavailable` (E01033) without executing this attempt. Retry with
  backoff using the same key and request. An operation that takes effect before
  its response is retained can still execute again on retry.

  Two distinct 409 errors signal misuse:

  - `request_in_progress` (E01004): The same key is currently being
    processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  - `idempotency_key_reuse` (E01005): The same key has already completed
    against a different request body or method. Generate a new key.

  Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Request body

- `name` (string, required): 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` (string): The label colour as a `#RRGGBB` hex value.
- `description` (string): When to apply the label. People and agents read it when they decide which label fits.

## Response body

- `id` (string, required): ID of the label, accepted by every operation that takes a `label_id`. It stays the same when the label is renamed.
- `name` (string, required): 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` (nullable string, required): The label colour as a `#RRGGBB` hex value, or `null` when none is set.
- `description` (nullable string, required): When to apply the label, or `null` when none is set.
- `created_at` (string, required)
- `updated_at` (string, required)

## Related resources

- [What is omnichannel vs multichannel messaging?](/explained/engagement/what-is-omnichannel-vs-multichannel) (answer)
- [Build your first integration](/learn/paths/integration) (course)

[Get an implementation brief](/learn/workspace?topic=omnichannel)
