APIs

Update Campaign

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

Update one or more specific parameters for the selected campaign.

Path Params
integer
required

The identifier for an existing campaign.

Example: 7
Query Params
string

The start date for the campaign.

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

The end date for the campaign.

Format: YYYY-MM-DD
Example: "2022-01-31"
string

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

Example: "http://charles.plumgroup.com/~schan/src/charles/vxml/start.php"
string

The URL for post-call processing.

Example: "http://myserver.com/storesmsresults.php"
profiles
array of objects

For each profile, enter an array containing the following key/value pairs PROFILE (string). The nickname set for your chosen profile. The time campaign calls will start. Eastern timezone. The time campaign calls will end. Eastern timezone.

IMPORTANT – PLEASE READ!
The profile(s) submitted here will overwrite ALL of the selected campaign's attached profiles.

Examples:
1 profile:
[{"profile":"JanuaryMornings", "start_time":"08:00", "end_time":"21:00"}]
2 profiles:
[{"profile":"MorningPace", "start_time":"08:00", "end_time":"11:00"},{"profile":"AfternoonPace", "start_time":"12:00", "end_time":"16:00"}]
profiles
string

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

Example:
6
"3wkdays"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 3 years ago

Language
Credentials
Bearer
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