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

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

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

## Request

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

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateCommandRequest
  - `type` 'mark_read' | 'mark_unread' | 'archive' | 'unarchive' | 'trash' | 'restore' | 'spam' | 'not_spam' | 'star' | 'unstar' | 'add_label' | 'remove_label' | 'move' | 'assign' | 'set_work_status', required
  - `target` object, required
    - `thread_id` string, uuid, required
  - `parameters` object

## Response `202`

Command committed and queued for provider execution.

- object
  - `data` Command, required
    - `id` string, uuid, required
    - `type` string, required
    - `status` 'accepted' | 'executing' | 'succeeded' | 'failed', required
    - `workspace_revision` integer, required
    - `created_at` string, date-time, required

## Other responses

- `409`: Idempotency key was reused for a different payload.

---

[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)