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

# Start a campaign

> Checks the campaign can run (contacts, phone numbers, wallet balance, schedule) and starts dialing. See the [start checks](/guides/run-a-campaign#4-start).

**Required scope:** `campaigns.edit`


## OpenAPI

````yaml /api-reference/openapi.json post /campaigns/{id}/start
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/{id}/start:
    post:
      summary: Start a campaign
      description: >-
        Checks the campaign can run (contacts, phone numbers, wallet balance,
        schedule) and starts dialing. See the [start
        checks](/guides/run-a-campaign#4-start).
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reservedConcurrency:
                  type: integer
                  minimum: 1
                  maximum: 1000
                allowBurst:
                  type: boolean
                  enum:
                    - false
              additionalProperties: false
      responses:
        '204':
          description: OK
        '400':
          description: >-
            - `campaign_channel_needs_agent`: Voice-leg campaign has no agent.

            - `campaign_channel_needs_email_sender`: EMAIL campaign has no
            sender mailbox.

            - `campaign_channel_needs_email_template`: EMAIL campaign has no
            email template.

            - `campaign_channel_needs_sender`: Message-leg campaign has no
            WhatsApp sender.

            - `campaign_channel_needs_template`: Message-leg campaign has no
            outreach template, or the template id does not exist.

            - `campaign_channel_needs_workflow`: CUSTOM-channel campaign has no
            workflow attached.

            - `campaign_is_inbound_misconfigured`: An outbound-style campaign
            uses an INBOUND agent and has no contacts.

            - `campaign_no_pending_contacts`: Campaign has no PENDING contacts
            to dial or enrol.

            - `campaign_no_phone_numbers`: Voice campaign has no phone numbers
            on an enabled carrier attached.

            - `campaign_not_startable`: Campaign status is not DRAFT, PAUSED or
            CREDIT_EXHAUSTED (or a journey or inbound campaign is in a
            non-startable state).

            - `campaign_schedule_expired`: Campaign's scheduledEndAt is in the
            past.

            - `campaign_workflow_not_active`: Journey campaign's workflow is
            missing or not ACTIVE at start.

            - `inbound_did_has_no_agent`: The number has no ACTIVE INBOUND agent
            assigned.

            - `inbound_did_unavailable`: Inbound campaign's phone number is
            missing, not assigned to this workspace, or its carrier is disabled.

            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_reserved_concurrency`: reservedConcurrency value out of
            range.

            - `outreach_template_needs_runtime_context`: Outreach template has
            bindings that can only be filled at runtime.

            - `outreach_template_not_approved`: Outreach template is not
            APPROVED.

            - `reserved_exceeds_allocation`: Running campaigns would reserve
            more concurrent calls than your workspace has.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '402':
          description: >-
            - `activity_frozen`: Workspace activity is frozen.

            - `insufficient_credits`: Wallet balance too low (and no active
            trial).

            - `workspace_not_active`: Workspace is not ACTIVE, so no billable
            activity is allowed.
        '403':
          description: >-
            - `api_key_not_allowed`: This action needs a person signed in to the
            dashboard (sign-ins, payments, email, and similar).

            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `campaign_not_found`: No campaign with that id in this workspace.

            - `workflow_not_found`: No workflow with that id (or workflows not
            enabled).
        '409':
          description: >-
            - `inbound_did_already_in_campaign`: The number already belongs to a
            non-terminal inbound campaign.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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