Skip to main content
POST
/
api
/
workers
/
{workerId}
/
deployments
/
voicev1
/
{deploymentId}
/
campaigns
/
{campaignId}
/
run
Run a campaign with provided data
curl --request POST \
  --url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/deployments/voicev1/{deploymentId}/campaigns/{campaignId}/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "data": [
    {
      "id": "<string>",
      "phoneNumber": "<string>",
      "status": "PENDING"
    }
  ]
}'

Authorizations

​
x-api-key
string
header
required

API key authentication

Path Parameters

​
workerId
string
required
​
deploymentId
string
required
​
campaignId
string
required

Body

application/json
​
data
object[]
required

Array of data objects to process in the campaign

Response

Campaign started successfully