> ## Documentation Index
> Fetch the complete documentation index at: https://docs.outbound.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a campaign

> Creates a draft campaign that writes to the people on up to 10 of your people lists (`listIds`). A `manual` campaign (the default) is ready at once, with one empty step for each of its `channels` (`email` when left out): write them with `PATCH /v1/campaigns/{campaignId}/steps/{stepId}`. An `ai-generated` campaign has its steps written from `prompt` in the background: read it with `GET /v1/campaigns/{campaignId}` until `initializationStatus` is `completed` or `failed`. A `templateId` copies a saved template's steps, which decide the channels.

Nothing is sent until you launch it with `POST /v1/campaigns/{campaignId}/launch`. Messages go out from 9:00 to 17:00 in `timezone` (UTC when left out) on `emailDays` (Monday to Friday when left out). Open and click tracking are off unless you turn them on; with click tracking on, links go through your tracking domain once it is active (`GET /v1/tracking-domains`).

A list, template, writing style or knowledge hub the organization does not have answers `404` with its own code, such as `list_not_found`. Lists with nobody the channels can reach (no work email for email steps, no LinkedIn profile for LinkedIn steps) answer `422` `list_incompatible_with_channels`.

Free. **Scope:** campaigns, with a key that can write.



## OpenAPI

````yaml /openapi.json post /v1/campaigns
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Lists
    description: >-
      Keep people or companies in lists: create and change lists, page through
      their rows, and add or remove people.
  - name: Folders
    description: Group lists of one kind into folders.
  - name: Enrichment
    description: >-
      Find people's work emails and phone numbers: one person, a batch of
      people, or a list.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged, and stopping them.
  - name: Accounts
    description: >-
      Connect the mailboxes and LinkedIn seats that campaigns and the inbox send
      from, and look after them.
  - name: Campaigns
    description: >-
      Email and LinkedIn campaigns: their steps, the people they enroll, their
      queue of messages, templates, the knowledge hubs and writing styles AI
      steps are written from, the tracking domain their links go through, and
      the lists every campaign leaves out.
  - name: Inbox
    description: >-
      Read and answer the conversations of your mailboxes and LinkedIn seats,
      and send new messages and invitations.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/campaigns:
    post:
      tags:
        - Campaigns
      summary: Create a campaign
      description: >-
        Creates a draft campaign that writes to the people on up to 10 of your
        people lists (`listIds`). A `manual` campaign (the default) is ready at
        once, with one empty step for each of its `channels` (`email` when left
        out): write them with `PATCH /v1/campaigns/{campaignId}/steps/{stepId}`.
        An `ai-generated` campaign has its steps written from `prompt` in the
        background: read it with `GET /v1/campaigns/{campaignId}` until
        `initializationStatus` is `completed` or `failed`. A `templateId` copies
        a saved template's steps, which decide the channels.


        Nothing is sent until you launch it with `POST
        /v1/campaigns/{campaignId}/launch`. Messages go out from 9:00 to 17:00
        in `timezone` (UTC when left out) on `emailDays` (Monday to Friday when
        left out). Open and click tracking are off unless you turn them on; with
        click tracking on, links go through your tracking domain once it is
        active (`GET /v1/tracking-domains`).


        A list, template, writing style or knowledge hub the organization does
        not have answers `404` with its own code, such as `list_not_found`.
        Lists with nobody the channels can reach (no work email for email steps,
        no LinkedIn profile for LinkedIn steps) answer `422`
        `list_incompatible_with_channels`.


        Free. **Scope:** campaigns, with a key that can write.
      operationId: postCampaigns
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The campaign's name.
                  minLength: 1
                  maxLength: 200
                  example: Portugal freight ops
                type:
                  type: string
                  description: >-
                    `manual` (the default): you write every step.
                    `ai-generated`: the steps are written from `prompt` in the
                    background.
                  enum:
                    - manual
                    - ai-generated
                listIds:
                  type: array
                  description: >-
                    1 to 10 of your people lists. Their people are enrolled once
                    each, in the order the lists are given, when the campaign
                    launches.
                  minItems: 1
                  maxItems: 10
                  uniqueItems: true
                  items:
                    type: string
                    minLength: 24
                    maxLength: 24
                    pattern: ^[0-9a-fA-F]+$
                channels:
                  type: array
                  description: >-
                    One empty step is made for each channel, in order: `email`,
                    `linkedin_connection` (an invitation), `linkedin_message`
                    (to a connection) or `inmail`. `["email"]` when left out. At
                    most one `linkedin_connection`, before every
                    `linkedin_message`. Not with `templateId`.
                  minItems: 1
                  maxItems: 10
                  items:
                    type: string
                    enum:
                      - email
                      - linkedin_connection
                      - linkedin_message
                      - inmail
                templateId:
                  type: string
                  description: >-
                    A campaign template whose steps are copied into the
                    campaign; they decide its channels, so send no `channels`
                    with it.
                  minLength: 24
                  maxLength: 24
                  pattern: ^[0-9a-fA-F]+$
                prompt:
                  type: string
                  description: >-
                    `ai-generated` only: what you offer and to whom, up to 5,000
                    characters. The steps are written from it.
                  maxLength: 5000
                writingStyleId:
                  type: string
                  description: >-
                    `ai-generated` only: the writing style the steps follow.
                    Your default style when left out.
                  minLength: 24
                  maxLength: 24
                  pattern: ^[0-9a-fA-F]+$
                knowledgeHubId:
                  type: string
                  description: >-
                    `ai-generated` only: the knowledge hub the steps draw on.
                    Your default hub when left out.
                  minLength: 24
                  maxLength: 24
                  pattern: ^[0-9a-fA-F]+$
                startDate:
                  type: string
                  description: >-
                    When sending may start, as an ISO 8601 date-time. Now when
                    left out.
                timezone:
                  type: string
                  description: >-
                    The IANA time zone the sending days and hours (9:00 to
                    17:00) are read in, such as `Europe/Lisbon`: a region, not
                    an abbreviation such as EST. UTC when a campaign is created
                    without one.
                emailDays:
                  type: array
                  description: >-
                    The days messages may go out, by English name with a capital
                    first letter. Monday to Friday when left out.
                  minItems: 1
                  maxItems: 7
                  uniqueItems: true
                  items:
                    type: string
                    enum:
                      - Monday
                      - Tuesday
                      - Wednesday
                      - Thursday
                      - Friday
                      - Saturday
                      - Sunday
                excludeLists:
                  type: array
                  description: >-
                    Up to 10 people lists whose people are never enrolled,
                    matched by person, email address or LinkedIn profile. An id
                    that is not one of your lists excludes nobody.
                  maxItems: 10
                  uniqueItems: true
                  items:
                    type: string
                    minLength: 24
                    maxLength: 24
                    pattern: ^[0-9a-fA-F]+$
                excludeCompanyLists:
                  type: array
                  description: >-
                    Up to 20 company or people lists: nobody who works at one of
                    their companies is enrolled. A list the organization does
                    not have answers `422` `exclude_company_lists_invalid`.
                  maxItems: 20
                  uniqueItems: true
                  items:
                    type: string
                    minLength: 24
                    maxLength: 24
                    pattern: ^[0-9a-fA-F]+$
                excludeContacted:
                  type: string
                  description: >-
                    Skips people your campaigns already wrote to: `none` (the
                    default) skips nobody, `ever` skips everyone written to, and
                    `last_1_month` to `last_1_year` skip those written to in
                    that time.
                  enum:
                    - none
                    - ever
                    - last_1_month
                    - last_3_months
                    - last_6_months
                    - last_1_year
                excludeEngagedContacts:
                  type: boolean
                  description: >-
                    Skips people who replied to one of your campaigns. False
                    when left out.
                isDynamic:
                  type: boolean
                  description: >-
                    Enrolls people added to the campaign's lists after launch,
                    as they arrive. False when left out.
                addUnsubscribeLink:
                  type: boolean
                  description: >-
                    Ends every email with a one-click unsubscribe link. True
                    when left out.
                openRateTrackingEnabledAt:
                  type: string
                  description: >-
                    Turns open tracking on from this ISO 8601 date-time, or off
                    with null. Off when left out.
                clickTrackingEnabledAt:
                  type: string
                  description: >-
                    Turns click tracking on from this ISO 8601 date-time, or off
                    with null. Off when left out. A step that waits for a click
                    needs it on.
                sendOnlyToValidatedEmailsEnabledAt:
                  type: string
                  description: >-
                    From this ISO 8601 date-time, enrolls only people whose
                    email address checked `valid`; null also enrolls catch-all
                    and unchecked addresses.
                dailyEmailLimit:
                  type: integer
                  description: >-
                    The most emails the campaign sends a day, 1 to 10,000, or
                    null for no limit.
                  minimum: 1
                  maximum: 10000
                dailyLinkedinConnectionLimit:
                  type: integer
                  description: >-
                    The most LinkedIn invitations the campaign sends a day, 1 to
                    10,000, or null for no limit.
                  minimum: 1
                  maximum: 10000
                dailyLinkedinMessageLimit:
                  type: integer
                  description: >-
                    The most LinkedIn messages and InMails the campaign sends a
                    day, 1 to 10,000, or null for no limit.
                  minimum: 1
                  maximum: 10000
                ctaLink:
                  type: string
                  description: >-
                    The link steps insert where they write `{CTA Link}`: an http
                    or https URL, or null or empty for none.
                  maxLength: 2000
              required:
                - name
                - listIds
            example:
              name: Portugal freight ops
              listIds:
                - 6a1f0c2b9d4e8a7f3c5b2e20
              channels:
                - email
                - linkedin_connection
              timezone: Europe/Lisbon
              dailyEmailLimit: 40
      responses:
        '201':
          description: 'The new campaign, a draft: `initializing` until it is launched.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - status
                properties:
                  id:
                    type: string
                  status:
                    type: string
              example:
                id: 6a1f0c2b9d4e8a7f3c5b2e30
                status: initializing
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.005000'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.995000'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. When
        the limit reached does not say when it resets, such as a mail provider's
        own limit on a mailbox, Retry-After is 60. The RateLimit headers
        describe this API's own limits, so they come only with a 429 one of
        those gave. The body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://docs.outbound.dev/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.