---
title: "POST /v1/campaigns"
method: POST
path: "/v1/campaigns"
tags: ["GTM verbs"]
---

# POST /v1/campaigns

`POST /v1/campaigns`

## Request

- Base URL: `https://api.layrcake.dev`
- URL: `https://api.layrcake.dev/v1/campaigns`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `name` string, required
  - `leads` object[], required
    - `email` string, required
    - `first_name` string
    - `last_name` string
    - `company_name` string
    - `location` string
    - `custom` object
  - `steps` object[], required
    - `subject` string
    - `body` string, required
    - `wait_days` integer: Days to wait after the previous step before this step is sent. Ignored on the first step, which sends at launch within the sending window.
  - `sending_window` object
    - `timezone` 'Europe/London' | 'Europe/Dublin' | 'Europe/Paris' | 'Europe/Berlin' | 'America/New_York' | 'America/Denver' | 'America/Phoenix' | 'America/Toronto' | 'Australia/Sydney' | 'Asia/Singapore' | 'Etc/UTC' | 'Etc/GMT+12' | 'Etc/GMT+11' | 'Etc/GMT+10' | 'America/Anchorage' | 'America/Dawson' | 'America/Creston' | 'America/Chihuahua' | 'America/Boise' | 'America/Belize' | 'America/Chicago' | 'America/Bahia_Banderas' | 'America/Regina' | 'America/Bogota' | 'America/Detroit' | 'America/Indiana/Marengo' | 'America/Caracas' | 'America/Asuncion' | 'America/Glace_Bay' | 'America/Campo_Grande' | 'America/Anguilla' | 'America/Santiago' | 'America/St_Johns' | 'America/Sao_Paulo' | 'America/Argentina/La_Rioja' | 'America/Araguaina' | 'America/Godthab' | 'America/Montevideo' | 'America/Bahia' | 'America/Noronha' | 'America/Scoresbysund' | 'Atlantic/Cape_Verde' | 'Africa/Casablanca' | 'America/Danmarkshavn' | 'Europe/Isle_of_Man' | 'Atlantic/Canary' | 'Africa/Abidjan' | 'Arctic/Longyearbyen' | 'Europe/Belgrade' | 'Africa/Ceuta' | 'Europe/Madrid' | 'Europe/Sarajevo' | 'Africa/Algiers' | 'Africa/Windhoek' | 'Asia/Nicosia' | 'Asia/Beirut' | 'Africa/Cairo' | 'Asia/Damascus' | 'Europe/Bucharest' | 'Africa/Blantyre' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Asia/Jerusalem' | 'Africa/Tripoli' | 'Asia/Amman' | 'Asia/Baghdad' | 'Europe/Kaliningrad' | 'Asia/Aden' | 'Africa/Addis_Ababa' | 'Europe/Kirov' | 'Europe/Astrakhan' | 'Asia/Tehran' | 'Asia/Dubai' | 'Asia/Baku' | 'Indian/Mahe' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Asia/Kabul' | 'Antarctica/Mawson' | 'Asia/Yekaterinburg' | 'Asia/Karachi' | 'Asia/Kolkata' | 'Asia/Colombo' | 'Asia/Kathmandu' | 'Antarctica/Vostok' | 'Asia/Dhaka' | 'Asia/Rangoon' | 'Antarctica/Davis' | 'Asia/Novokuznetsk' | 'Asia/Hong_Kong' | 'Asia/Krasnoyarsk' | 'Asia/Brunei' | 'Australia/Perth' | 'Asia/Taipei' | 'Asia/Choibalsan' | 'Asia/Irkutsk' | 'Asia/Dili' | 'Asia/Pyongyang' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Australia/Brisbane' | 'Australia/Melbourne' | 'Antarctica/DumontDUrville' | 'Australia/Currie' | 'Asia/Chita' | 'Antarctica/Macquarie' | 'Asia/Sakhalin' | 'Pacific/Auckland' | 'Etc/GMT-12' | 'Pacific/Fiji' | 'Asia/Anadyr' | 'Asia/Kamchatka' | 'Etc/GMT-13' | 'Pacific/Apia'
    - `days` string[]
    - `start_hour` integer
    - `end_hour` integer
  - `stop_on_reply` true
  - `dry_run` boolean

## Response `200`

Successful outcome

- object
  - `result` union, required
    - object
      - `history_available` boolean
      - `campaign_id` string, required
      - `name` string, required
      - `state` 'draft' | 'incomplete' | 'launching' | 'active' | 'paused' | 'completed' | 'failed', required
      - `leads_accepted` integer, required
      - `leads_suppressed` integer, required
      - `suppressed_reasons` object
      - `removed` object
        - `opted_out` integer, required
        - `do_not_contact` integer
        - `no_location` integer
        - `excluded` integer
        - `invalid` integer, required
        - `platform_blocked` integer, required
        - `contacted_recently` integer
        - `capped` integer, required
        - `other` integer, required
        - `total` integer, required
      - `removed_examples` string[]
      - `created_at` string, required
      - `leads_correlated` integer
      - `leads_pending` integer
      - `leads_rejected` integer
      - `campaign_lead_total` integer
    - object
      - `dry_run` true, required
      - `advisory` true, required
      - `evaluated_at` string, required
      - `plan` object, required
        - `verb` 'create_campaign', required
        - `plan_version` 3, required
        - `input_version` string, required
        - `credits_estimate` string, required
        - `would_exceed` string[], required
        - `warnings` string[], required
        - `would` object, required
          - `state` 'draft', required
          - `leads_accepted` integer, required
          - `leads_suppressed` integer, required
          - `removed` object, required
            - `opted_out` integer, required
            - `do_not_contact` integer
            - `no_location` integer
            - `excluded` integer
            - `invalid` integer, required
            - `platform_blocked` integer, required
            - `contacted_recently` integer
            - `capped` integer, required
            - `other` integer, required
            - `total` integer, required
          - `history_available` boolean
  - `layrcake` object, required
    - `request_id` string, uuid, required
    - `credits_charged` string, required
    - `credits_available` string, required
    - `replayed` boolean
    - `route` object
      - `used` 'balanced' | 'cheapest' | 'broadest' | 'fastest', required
      - `source` 'request' | 'key' | 'guess' | 'default', required

## Other responses

- `4XX`: Caller, scope, confirmation, or credit error
- `5XX`: Provider or service error

---

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