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

# Pause a campaign

> Pauses an active campaign, halting outreach to all prospects until resumed. Optionally pause all prospects in the campaign.

<Note>Pauses an active campaign, halting outreach to all prospects. Resume with [Resume a campaign](/api-reference/campaigns/resume).</Note>


## OpenAPI

````yaml POST /campaigns/{campaignId}/pause
openapi: 3.1.0
info:
  title: Alta API
  description: >-
    The Alta public API allows you to programmatically access and manage your
    campaigns, prospects, companies, persons, email messages, LinkedIn messages,
    calls, reps, tags, and trigger assistant calls.
  version: 1.0.0
servers:
  - url: https://api.altahq.com/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/{campaignId}/pause:
    post:
      tags:
        - Campaigns
      summary: Pause a campaign
      description: >-
        Pauses an active campaign, halting outreach to all prospects until
        resumed. Optionally pause all prospects in the campaign.
      operationId: pauseCampaign
      parameters:
        - name: campaignId
          in: path
          required: true
          description: The UUID of the campaign to pause.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                pauseProspects:
                  type: boolean
                  description: >-
                    When `true`, also pauses all active prospects in the
                    campaign.
      responses:
        '200':
          description: Campaign paused successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Authentication failed - invalid or missing API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API token
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: NotFound
            message: Resource not found
    RateLimited:
      description: >-
        Too many requests - you've exceeded the rate limit of 100 requests per
        minute.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: TooManyRequests
            message: Rate limit exceeded. Please retry after 60 seconds.
  schemas:
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Error type.
        message:
          type: string
          description: Human-readable error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token authentication. Generate a token from the Alta dashboard and
        pass it as a Bearer token in the Authorization header.

````