> ## 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.

# Cancel Campaign

> Cancels the given campaign. If campaign is running, this will also stop all future scheduled emails. Existing campaign data will remain as it is. Once cancelled, this campaign cannot be restarted.



## OpenAPI

````yaml /openapi-v1.yml post /api/v1/campaign/cancel/
openapi: 3.1.1
info:
  title: DeliverymanAI API V1
  version: 1.0.0
  description: >-
    API documentation for version 1 of the DeliverymanAI API. These endpoints
    drive campaigns, contact lists, leads and email sequences from your own
    code.


    V1 is in maintenance: it keeps working and existing integrations do not need
    to change, but new features are only added to V2. If you are starting a new
    integration, use V2.


    V1 and V2 share the same API keys, sent in the `X-Api-Key` header.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v1/campaign/cancel/:
    post:
      tags:
        - Campaign
      summary: Cancel Campaign
      description: >-
        Cancels the given campaign. If campaign is running, this will also stop
        all future scheduled emails. Existing campaign data will remain as it
        is. Once cancelled, this campaign cannot be restarted.
      operationId: campaign_cancel_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelCampaignRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CancelCampaignRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CancelCampaignRequest'
        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: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl -X POST "https://api.deliveryman.ai/api/v1/campaign/cancel/" \
              -H "X-Api-Key: YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "campaign_uid": "cmp_4b1f7a92c3d84e05"
              }'
components:
  schemas:
    CancelCampaignRequest:
      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: >-
        Your API key. In the dashboard, go to Integrations and open Deliveryman
        API Keys to create one.

````

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