Campaigns

Create a campaign

View as Markdown
Create a campaign

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
namestringRequired
The name of the campaign
audienceIdstringRequired
The ID of the audience
agentIdstringRequired
The ID of the agent
descriptionstringOptional
The description of the campaign
phoneNumberIdslist of stringsOptional

Optional list of caller-ID phone number IDs to rotate across when placing outbound calls for this campaign. If omitted, the agent’s default phone number is used.

scheduledAtdatetimeOptional

Optional ISO-8601 timestamp for when the campaign should start dialing. Must be in the future. If provided, the campaign is created in scheduled status; otherwise it starts in draft status and must be started manually.

maxRetriesintegerOptional0-10Defaults to 3

Maximum number of times a failed call is retried before the participant is marked as failed. 0 disables retries.

retryDelayintegerOptional1-1440Defaults to 15
Delay in minutes between retry attempts for a failed call.

Response

Campaign created successfully. Note: the response is the raw Mongoose document — agentId and audienceId are plain ObjectId strings here, not nested objects as returned by GET endpoints.

statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error