APIs

Create Campaign

post
https://scheduler.plumvoice.com/api/campaigns

Creates a new campaign.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The start date for the campaign.

Format: YYYY-MM-DD
Example: 2022-01-01

string
required

The end date for the campaign.

Format: YYYY-MM-DD
Example: 2022-01-01

string
required

The URL of the VXML application to use in each call.

string

The URL for post-call processing.

file
required

The .CSV or .TXT file containing phone numbers to be called.

string
required

For each profile, enter an array containing the following key/value pairs PROFILE, the profile_id set for your chosen profile. The time campaign calls will start. Eastern timezone. The time campaign calls will end. Eastern timezone.
"Examples:"
1 profile:
[{"profile": 30, "start_time":"08:00", "end_time":"21:00"}]

2 profiles:
[{"profile": 30, "start_time":"08:00", "end_time":"11:00"},
{"profile": 31, "start_time":"12:00", "end_time":"16:00"}]

string
required

The schedule to apply to the campaign. Accepts one (1) schedule's schedule_id number or nickname, whichever you choose.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 3 years ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 3 years ago