---
title: "POST /v1/workspaces"
method: POST
path: "/v1/workspaces"
---

# POST /v1/workspaces

`POST /v1/workspaces`

## Request

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

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `name` string, required

## Response `200`

Idempotent replay of a previously created workspace.

- object
  - `data` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `shard` string, required
    - `role` 'owner' | 'admin' | 'member' | 'viewer' | 'partner', required
    - `revision` integer, required
    - `name_source` 'signup' | 'brand' | 'user', required: Where the workspace name came from: signup (automatic sign-up name), brand (the company or brand confirmed in onboarding), or user (typed by a person; brand confirmations no longer rename it).
    - `owner_email` string, nullable, required: The earliest active owner's email address. Null when the caller is a static API key or the owner has no recorded address.
    - `avatar_url` string, nullable, required: The workspace's brand mark: the default product's brand logo, else the logo of the most recently confirmed company discovery.
    - `replayed` boolean, required

## Other responses

- `201`: Workspace created with free entitlements and the actor as owner.

---

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