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

# Launch a campaign

> Make a draft campaign live. This is the only way a draft starts sending. It checks everything at once: a sequence with written emails, a sending inbox, at least one lead, and a plan that can send. When something is missing the response is `409` with every issue listed.

**Sending starts right away for leads already enrolled.** An API key needs the **Send outreach** permission (`outreach:send`).



## OpenAPI

````yaml POST /api/outreach/campaigns/{id}/launch
openapi: 3.1.0
info:
  title: ManyPI API
  description: >-
    The REST API behind ManyPI — AI lead generation, email validation,
    cold-email outreach, agent runs and web scraping. Every endpoint is
    authenticated with a ManyPI API key (`mpi_...`) or an OAuth 2.1 access
    token, and honours the permissions granted to that credential.


    API keys carry permissions per area of the API (Leads & companies,
    Campaigns, Inboxes & replies, Agents & skills, Scrapers & data, Account &
    usage), each set to Read or Read & write, plus separate permissions for
    actions that spend credits or reach the outside world: Run agents, Run
    scrapers, Verify email addresses, Send outreach and Invoke endpoints. Each
    operation below names what it needs. Keys with the older `read` and `write`
    permissions keep working everywhere.
  version: 2.0.0
  contact:
    name: ManyPI Support
    email: support@manypi.com
    url: https://manypi.com
servers:
  - url: https://app.manypi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Find, store, enrich and manage leads.
  - name: Email validation
    description: Verify that lead addresses can receive mail.
  - name: Outreach
    description: Inboxes, sequences, campaigns, sending and replies.
  - name: Agent
    description: Agent runs, replies and skills.
  - name: Scraping
    description: Scrapers, runs and extracted data.
  - name: Endpoints
    description: Publish scrapers as typed REST endpoints.
  - name: Account
    description: Key validation and account information.
  - name: Imports
    description: >-
      Bring campaigns, leads and the do-not-contact list over from another
      outreach tool.
paths:
  /api/outreach/campaigns/{id}/launch:
    post:
      tags:
        - Outreach
      summary: Launch a campaign
      description: >-
        Make a draft campaign live. This is the only way a draft starts sending.
        It checks everything at once: a sequence with written emails, a sending
        inbox, at least one lead, and a plan that can send. When something is
        missing the response is `409` with every issue listed.


        **Sending starts right away for leads already enrolled.** An API key
        needs the **Send outreach** permission (`outreach:send`).
      operationId: launchCampaign
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Launched.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  campaign:
                    $ref: '#/components/schemas/Campaign'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: The workspace is locked for billing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Sending needs the Starter plan or above (`code: "outreach_locked"`).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Not ready to launch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        message:
                          type: string
                        tab:
                          type: string
                          enum:
                            - editor
                            - leads
                            - settings
              example:
                error: This campaign is not ready to launch yet.
                issues:
                  - field: inboxes
                    message: Connect a sending inbox
                    tab: settings
components:
  schemas:
    Campaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - archived
          description: >-
            A campaign without a sequence or an inbox starts as `draft`. A draft
            goes live only through `POST /api/outreach/campaigns/{id}/launch`.
        sequence_id:
          type: string
          format: uuid
        smtp_config_id:
          type: string
          format: uuid
        reply_to:
          type: string
          nullable: true
        daily_limit:
          type: integer
          nullable: true
        priority:
          type: integer
        schedule_enabled:
          type: boolean
        send_days:
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 6
          description: >-
            Weekdays to send on, as `Date.getDay()` numbers: 0 is Sunday, 1 is
            Monday, 6 is Saturday. Values outside 0-6 are discarded, so an
            ISO-style Sunday of 7 is dropped rather than honoured. Defaults to
            `[1,2,3,4,5]` when omitted, or when every supplied value is
            discarded.
        send_from:
          type: string
          nullable: true
        send_to:
          type: string
          nullable: true
        timezone:
          type: string
          nullable: true
        track_opens:
          type: boolean
        inbox_strategy:
          type: string
          enum:
            - single
            - rotate
            - round_robin
            - provider_match
          description: How sends are spread when several inboxes are available.
        include_unsubscribe:
          type: boolean
          description: Whether an unsubscribe link is appended to each email.
        require_verified:
          type: boolean
          description: Whether unverified addresses are validated before enrollment.
        stats:
          type: object
          properties:
            enrolled:
              type: integer
            active:
              type: integer
            completed:
              type: integer
            sent:
              type: integer
            failed:
              type: integer
            opened:
              type: integer
            replied:
              type: integer
            bounced:
              type: integer
            unsubscribed:
              type: integer
              description: Leads who opted out.
            unsubscribed_sends:
              type: integer
              description: Sends that went to an address which later opted out.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          description: >-
            Human-readable message. A few validation failures (creating or
            updating an endpoint, bulk lead updates and deletes) send a list of
            the individual problems here instead of one string.
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      type:
                        - string
                        - integer
                  message:
                    type: string
        code:
          type: string
          description: >-
            A machine-readable code on gated failures: `lead_limit`,
            `outreach_locked`, `validation_credits_exhausted`.
        details:
          description: >-
            Extra detail on some failures, such as the list of parameters that
            failed an endpoint's `param_schema`.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired credential, or an API key without the
        permission this route needs. Both look the same, so check the key's
        permissions under API Access when a key that worked elsewhere is
        refused. A few routes check the key themselves and answer `403` instead.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A ManyPI API key (`mpi_...`) from the profile menu → API Access in the
        dashboard, or an OAuth 2.1 access token obtained through the MCP consent
        flow.

````

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