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

# Pause Campaign

> Pauses the given running campaign. Paused campaigns can be resumed later using `/campaign/resume` api.



## OpenAPI

````yaml /openapi.yml post /api/v1/campaign/pause/
openapi: 3.1.1
info:
  title: DeliverymanAI API
  version: 1.0.0
  description: >-
    API documentation for DeliverymanAI, a Cold Email Management and Automation
    platform. This API provides endpoints for managing campaigns, contacts,
    email sequences, and related services.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v1/campaign/pause/:
    post:
      tags:
        - Campaign
      summary: Pause Campaign
      description: >-
        Pauses the given running campaign. Paused campaigns can be resumed later
        using `/campaign/resume` api.
      operationId: campaign_pause_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PauseCampaignRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PauseCampaignRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PauseCampaignRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Success
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Not Found
        '500':
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PauseCampaignRequest:
      type: object
      properties:
        campaign_uid:
          type: string
      required:
        - campaign_uid
    SimpleMessageResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: 'Enter your API key in the format: X-Api-Key <your_key>'

````