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

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

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

## Request

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

## Request body

- object
  - `name` string, required
  - `mailbox_id` string, uuid
  - `template_id` string, uuid, required
  - `subject_variants` string[]
  - `selected_subject_variant` integer, nullable
  - `audience` object, required
    - `all_subscribed` boolean
    - `contact_ids` string[]
    - `list_ids` string[]
    - `segment_ids` string[]

## Response `201`

Successful response.

- object
  - `data` Campaign, required
    - `id` string, uuid, required
    - `product_id` string, uuid
    - `name` string, required
    - `mailbox_id` string, uuid
    - `template_id` string, uuid, nullable
    - `managed_content_id` string, uuid, nullable
    - `managed_source_revision_id` string, uuid, nullable
    - `managed_publication_id` string, uuid, nullable
    - `managed_locales_snapshot` string[]
    - `expires_after_seconds` integer, nullable
    - `status` string, required
    - `version` integer, required
    - `subject_variants` string[]
    - `selected_subject_variant` integer
    - `content_overrides` object
    - `audience_query` CampaignAudience: Select all subscribed contacts or at least one nonempty contact_ids, list_ids, or segment_ids list.
      - `all_subscribed` boolean
      - `contact_ids` string[]
      - `list_ids` string[]
      - `segment_ids` string[]
    - `audience_frozen_at` string, date-time, nullable
    - `audience_recipient_count` integer, nullable
    - `audience_snapshot_sha256` string, nullable
    - `audience_snapshot_campaign_version` integer, nullable
    - `scheduled_at` string, date-time, nullable
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `archived_at` string, date-time, nullable
    - `stats` object

---

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