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

# Pause a campaign



## OpenAPI

````yaml /api-reference/openapi.json post /api/projects/{projectSlug}/campaigns/{id}/pause
openapi: 3.0.3
info:
  title: Polymorfa WhatsApp API
  version: 0.0.0
  description: >-
    Public Polymorfa REST API for sessions, messaging, media, webhooks,
    campaigns, templates, client tokens, widgets, and bridge routing.
  contact:
    name: Polymorfa API
    url: https://docs.polymorfa.com
servers:
  - url: https://api.polymorfa.com
security:
  - BearerAuth: []
paths:
  /api/projects/{projectSlug}/campaigns/{id}/pause:
    post:
      tags:
        - Campaigns
      summary: Pause a campaign
      operationId: pauseCampaign
      parameters:
        - schema:
            type: string
          required: true
          name: projectSlug
          in: path
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseCampaignResponse'
        '400':
          description: Bad request — request body or params failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment required — feature requires an upgraded plan/number tier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Authenticated but not permitted (missing scope or rule violation)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PauseCampaignResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/Campaign'
      required:
        - success
        - data
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        docs:
          type: string
          description: URL to the documentation for this error
      required:
        - error
    Campaign:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        templateId:
          type: string
          nullable: true
        recipientListId:
          type: string
          nullable: true
        recipientCount:
          type: number
        sentCount:
          type: number
        deliveredCount:
          type: number
        readCount:
          type: number
        failedCount:
          type: number
        skippedCount:
          type: number
        scheduledAt:
          type: number
          nullable: true
        launchedAt:
          type: number
          nullable: true
        completedAt:
          type: number
          nullable: true
        createdAt:
          type: number
        updatedAt:
          type: number
      required:
        - id
        - name
        - status
        - templateId
        - recipientListId
        - recipientCount
        - sentCount
        - deliveredCount
        - readCount
        - failedCount
        - skippedCount
        - scheduledAt
        - launchedAt
        - completedAt
        - createdAt
        - updatedAt
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Polymorfa organization key (titan_ prefix), project token (titan_pt_
        prefix), or client token (titan_ct_ prefix), where the operation permits
        that audience.

````