Skip to main content
POST
/
api
/
workers
/
{workerId}
/
deployments
/
voice
/
{deploymentId}
/
outbound-campaigns
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 outboundCampaign = await client.workers.deployments.voice.outboundCampaigns.create('deploymentId', {
  workerId: 'workerId',
  data: [{}],
});

console.log(outboundCampaign.id);
{
  "id": "<string>",
  "status": "<string>",
  "data": {},
  "batchSize": 123,
  "batchIntervalMinutes": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deploymentId": "<string>",
  "workerId": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "additionalData": {},
  "telephonyProvider": {},
  "flowId": "<string>",
  "createdById": "<string>"
}

Authorizations

x-api-key
string
header
required

API key authentication

Path Parameters

workerId
string
required
deploymentId
string
required

Body

application/json
data
object[]
required

Contact data array

name
string

Campaign name

description
string

Campaign description

batch_size
integer
default:1

Number of calls to make simultaneously

batch_interval_minutes
integer
default:2

Minutes to wait between batches

additional_data
object

Additional metadata

telephonyProvider
object

Telephony provider configuration

status
enum<string>

Campaign status

Available options:
CREATED,
STARTED,
RUNNING,
COMPLETED,
STOPPED,
FAILED
created_by
string

User ID who created the campaign

team_id
string

Team ID

flow_id
string

Flow ID

Response

Campaign created successfully

id
string
required
status
string
required
data
object
required
batchSize
integer
required
batchIntervalMinutes
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deploymentId
string
required
workerId
string
required
teamId
string
required
name
string | null
description
string | null
additionalData
object
telephonyProvider
object
flowId
string | null
createdById
string | null