v2

latestOpenAPI 3.1.02026-07-273779120.8 KB

Campaigns

Create Campaign

Create a new campaign configuration.

Returns the full campaign object on success. The campaign starts in 'pending' status — use the /action endpoint to launch it.

post/campaigns/v1/campaigns

callTypestring

Deprecated. Do not use — this field has no effect and will be removed in a future version.

namestring nullable

Name of the benefits verification configuration

campaignTypestring

Type of campaign (single/batch)

assistantNumbersstring[]

List of assistant phone numbers

timezonestring

Timezone for scheduling

reportEmailsstring[]

Email addresses for reports

statusstring

Current status of configuration

maxParallelCallsinteger nullable

Maximum number of concurrent calls

isReviewRequiredboolean

Review requirement flag

validateOnUploadboolean

Validate calls immediately after upload and before launch

tagsstring[]

Tags attached to this campaign

Campaign created successfully

messagestring required

Result description

{
  "message": "Campaign fetched successfully."
}