Skip to main content
POST
/
api
/
workers
/
{workerId}
/
deployments
/
voice
/
{deploymentId}
/
stop-campaign
JavaScript
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);
{
  "message": "Successfully stopped campaign abc123",
  "removedItems": [
    {}
  ],
  "removedCount": 5
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required

The worker ID

deploymentId
string
required

The deployment ID

Body

application/json
campaign_id
string
required

The campaign ID to stop

Response

Successfully stopped campaign

message
string
Example:

"Successfully stopped campaign abc123"

removedItems
object[]
removedCount
integer
Example:

5