---
title: "POST /v1/workspaces/{workspaceId}/labels"
method: POST
path: "/v1/workspaces/{workspaceId}/labels"
---

# POST /v1/workspaces/{workspaceId}/labels

`POST /v1/workspaces/{workspaceId}/labels`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/labels`
- Auth: HTTP bearer

Create a Banger label in one mailbox. Pass suggestion_id to create a suggested label; an existing name returns the existing label (200). Banger labels never sync to Gmail.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `mailbox_id` string, uuid, required
  - `name` string
  - `color` string
  - `emoji` string: One emoji shown before the name.
  - `description` string
  - `suggestion_id` string
  - `auto_set` LabelAutoSet
    - `enabled` boolean, required
    - `description` string, nullable
    - `exact_conditions` TriageExactConditions
      - `from` string[]
      - `to` string[]
      - `subject_contains` string[]
      - `has_words` string[]
      - `excludes_words` string[]
      - `has_attachment` boolean

## Response `200`

Successful response.

- object
  - `data` object, required
    - `id` string, uuid, required
    - `mailbox_id` string, uuid, required
    - `name` string, required
    - `color` string, nullable, required
    - `kind` string, required
    - `emoji` string, nullable, required
    - `description` string, nullable, required
    - `suggestion_id` string, nullable, required
    - `source` 'banger' | 'provider', required
    - `updated_at` string, date-time, required
    - `auto_set` object, nullable, required
      - `rule_id` string, uuid, required
      - `enabled` boolean, required
      - `description` string, nullable, required
      - `exact_conditions` TriageExactConditions, required
        - `from` string[]
        - `to` string[]
        - `subject_contains` string[]
        - `has_words` string[]
        - `excludes_words` string[]
        - `has_attachment` boolean
    - `applied_by_rule_count` integer, required

## Other responses

- `201`: Successful response.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)