v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Create an outbound campaign

Creates a new outbound campaign with specified recipients, voice agent, and scheduling configuration.

post/v1/voice-agents/campaigns

Request body

namestring required

Campaign name (1-100 characters).

phoneNumberstring required

Phone number to use for the campaign in E.164 format.

voiceAgentIdstring uuid required

Voice agent ID to use for the campaign.

sendType'NOW' | 'SCHEDULED' required

When to send the campaign. Use 'NOW' for immediate sending or 'SCHEDULED' for scheduled sending.

scheduledDatestring date-time

Scheduled date/time in ISO 8601 format (required when sendType is SCHEDULED).

scheduledTimezonestring

Timezone for scheduled campaign (required when sendType is SCHEDULED).

reservedConcurrencyinteger

Number of concurrent calls reserved for this campaign (must be positive). Defaults to 1 when omitted.

Example request

{
  "name": "Q1 Customer Outreach",
  "phoneNumber": "+14155551212",
  "voiceAgentId": "68f7656f-098b-4c43-b165-7cfd2cc8ac40",
  "recipients": [
    {
      "phoneNumber": "+1234567890",
      "name": "John Doe"
    }
  ],
  "sendType": "NOW",
  "timeRange": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY"
    ],
    "startCallingTime": "09:00",
    "endCallingTime": "17:00"
  },
  "scheduledDate": "2025-12-01T09:00:00Z",
  "scheduledTimezone": "America/New_York",
  "reservedConcurrency": 10
}

Response

Successful response

successboolean

messagestring

messageKeystring

Example response

{
  "success": true,
  "message": "Campaign created successfully",
  "messageKey": "CAMPAIGN_CREATED_SUCCESSFULLY",
  "data": {
    "id": "a8f7656f-098b-4c43-b165-7cfd2cc8ac50",
    "name": "Q1 Customer Outreach",
    "status": "SCHEDULED",
    "sendType": "NOW",
    "scheduledDate": "2025-12-01T09:00:00Z",
    "scheduledTimezone": "America/New_York",
    "timeRange": {
      "days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY"
      ],
      "startCallingTime": "09:00",
      "endCallingTime": "17:00"
    },
    "reservedConcurrency": 10,
    "webhookUrl": "https://example.com/webhook",
    "projectId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "userId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "voiceAgentId": "68f7656f-098b-4c43-b165-7cfd2cc8ac40",
    "phoneNumberId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "createdAt": "2025-12-06T10:00:00.000Z",
    "updatedAt": "2025-12-06T10:00:00.000Z"
  }
}