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

# Stop a specific campaign by removing its calls from the queue

> Removes all scheduled calls for a specific campaign from the Redis queue



## OpenAPI

````yaml /openapi-specs/brainbase-openapi.documented.json post /api/workers/{workerId}/deployments/voice/{deploymentId}/stop-campaign
openapi: 3.0.0
info:
  title: Brainbase REST API
  version: 1.0.3
  description: API documentation for Brainbase REST API
servers:
  - url: https://brainbase-monorepo-api.onrender.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Team
    description: Endpoints related to team functionalities
  - name: Integrations
    description: Endpoints for integrations
  - name: Assets
    description: Endpoints for asset management
  - name: Workers
    description: Endpoints for worker operations
  - name: Flows
    description: Endpoints for flow management
  - name: Voice Deployments
    description: Endpoints for voice deployments
  - name: Voice V1 Deployments
    description: Endpoints for voice v1 deployments
  - name: Voice Deployment Logs
    description: Endpoints for voice deployment logs
  - name: Voice Deployment Outbound Data
    description: Endpoints for voice deployment outbound data
  - name: Chat Deployments
    description: Endpoints for chat deployments
  - name: Chat Deployment Logs
    description: Endpoints for chat deployment logs
  - name: Tags
    description: Endpoints for tag management and worker tag assignment
  - name: Echo
    description: Endpoints for Echo test suites, agents, and scorecards
  - name: Flow Versions
    description: Endpoints for flow version control
  - name: Deployment History
    description: Endpoints for deployment change history
  - name: Deployment Parameters
    description: Endpoints for deployment parameters
  - name: Log Exports
    description: Endpoints for async log export to CSV/JSON
  - name: Logs
    description: >-
      Universal log lookup — fetch any deployment log by ID without needing
      worker or deployment context
  - name: Deployments
    description: >-
      Universal deployment lookup — fetch any deployment by ID without needing
      worker context
paths:
  /api/workers/{workerId}/deployments/voice/{deploymentId}/stop-campaign:
    post:
      tags:
        - Voice Deployments
      summary: Stop a specific campaign by removing its calls from the queue
      description: Removes all scheduled calls for a specific campaign from the Redis queue
      parameters:
        - name: workerId
          in: path
          required: true
          schema:
            type: string
          description: The worker ID
        - name: deploymentId
          in: path
          required: true
          schema:
            type: string
          description: The deployment ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - campaign_id
              properties:
                campaign_id:
                  type: string
                  description: The campaign ID to stop
      responses:
        '200':
          description: Successfully stopped campaign
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully stopped campaign abc123
                  removedItems:
                    type: array
                    items:
                      type: object
                      description: Queue items that were removed
                  removedCount:
                    type: integer
                    example: 5
        '400':
          description: Missing campaign_id
        '401':
          description: Unauthorized
        '404':
          description: Campaign not found
        '500':
          description: Internal server error
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import BrainbaseLabs from 'brainbase-labs';


            const client = new BrainbaseLabs({
              apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
            });


            const response = await
            client.workers.deployments.voice.stopCampaign('deploymentId', {
              workerId: 'workerId',
              campaign_id: 'campaign_id',
            });


            console.log(response.message);
        - lang: Python
          source: |-
            import os
            from brainbase_labs import BrainbaseLabs

            client = BrainbaseLabs(
                api_key=os.environ.get("BRAINBASE_LABS_API_KEY"),  # This is the default and can be omitted
            )
            response = client.workers.deployments.voice.stop_campaign(
                deployment_id="deploymentId",
                worker_id="workerId",
                campaign_id="campaign_id",
            )
            print(response.message)
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication

````