Schedule a campaign

POST /campaigns/{CampaignID}/schedule.{Format}

Schedules the delivery of a campaign by assigning a specific date and time.

Note

This API call is designed to assign the scheduled date time to the campaign, but not to send the campaign. If you would like to send the campaign at the scheduled time, you will need to call the Send a campaign API as well.

Request

Parameter	In	Type	Required	Description
Accept	header	string	true	Determines the expected format and data type to retrieve the response data.Value: application/json
CampaignID	path	string	true	The ID of the campaign that you want to schedule.
Format	path	string	true	The supported file format for getting a response.Possible values: json and xml.
apikey	query	string	true	The API key of your account.
DateTime	body	date	true	The specific date and time the campaign is scheduled to be delivered.Use the same format that you have in the Time and date settings in your account. For example, dd-mm-yyyy.
Timezone	body	string	false	The time zone of your specified date and time.If you don't specify any timezone value, the time zone in your time and date settings is used.

http

POST https://{hostname}/v3/campaigns/{CampaignID}/schedule.{Format}?apikey=

Request body:
{
  "DateTime": "24-06-2023 13:17",
  "Timezone": "US Eastern Standard Time"
}

curl

curl --include \\
     --request POST \\
     --header "Content-Type: application/json" \\
     --header "Accept: application/json" \\
     --data-raw '{
    "DateTime": "24-06-2023 13:17",
    "Timezone": "US Eastern Standard Time"
}' \\
'https://{hostname}/v3/campaigns/{CampaignID}/schedule.{Format}?apikey='

Timezone values

The available time zones are the following:

Dateline Standard Time
Samoa Standard Time
Hawaiian Standard Time
Alaskan Standard Time
Pacific Standard Time
Pacific Standard Time (Mexico)
US Mountain Standard Time
Mountain Standard Time
Central Standard Time
Central Standard Time (Mexico)
Canada Central Standard Time
SA Pacific Standard Time
US Eastern Standard Time
Eastern Standard Time
Venezuela Standard Time
Atlantic Standard Time
SA Western Standard Time
Central Brazilian Standard Time
Pacific SA Standard Time
Newfoundland Standard Time
E. South America Standard Time
Argentina Standard Time
SA Eastern Standard Time
Greenland Standard Time
Montevideo Standard Time
Mid-Atlantic Standard Time
Azores Standard Time
Cape Verde Standard Time
Greenwich Standard Time
GMT Standard Time
Morocco Standard Time
W. Central Africa Standard Time
Central European Standard Time
Romance Standard Time
W. Europe Standard Time
Namibia Standard Time
E. Europe Standard Time
Israel Standard Time
FLE Standard Time
South Africa Standard Time
Egypt Standard Time
Middle East Standard Time
GTB Standard Time
Jordan Standard Time
Iran Standard Time
Georgian Standard Time
E. Africa Standard Time
Russian Standard Time
Arab Standard Time
Arabic Standard Time
Caucasus Standard Time
Mauritius Standard Time
Azerbaijan Standard Time
Arabian Standard Time
Afghanistan Standard Time
West Asia Standard Time
Pakistan Standard Time
Ekaterinburg Standard Time
Sri Lanka Standard Time
India Standard Time
Nepal Standard Time
N. Central Asia Standard Time
Central Asia Standard Time
Myanmar Standard Time
North Asia Standard Time
SE Asia Standard Time
Taipei Standard Time
W. Australia Standard Time
Singapore Standard Time
North Asia East Standard Time
China Standard Time
Yakutsk Standard Time
Korea Standard Time
Tokyo Standard Time
AUS Central Standard Time
Cen. Australia Standard Time
AUS Eastern Standard Time
West Pacific Standard Time
Tasmania Standard Time
Vladivostok Standard Time
Central Pacific Standard Time
New Zealand Standard Time
Tonga Standard Time

Response

Status	Description	Headers	Schema
200 OK	The request is successful.	Content-Type /jsonAccept /json	N/A

json

{
  "Code": 0,
  "Error": null,
  "Context": null
}

Code - the response message. This is 0 if successful.
Error - the response error message. This is null if successful.
Context - this is null if successful.

If you have suggestions for improving this article, let us know!