Make a DELETE call to the /emails/activities/{campaign_activity_id}/schedules
endpoint to unschedule an email campaign activity by deleting the schedule. After you use this method to unschedule an email campaign activity, the email campaign activity reverts to the status prior to SCHEDULED
.
Unscheduling an email campaign activity allows you to make further updates to the email content if it was previously in Draft
status. Unscheduling an email campaign activity also allows you to change the date or time that you want Constant Contact to send the email campaign activity to contacts.
Parameters
This method requires the campaign_activity_id
URL parameter. Use this parameter to specify which email campaign activity you want to unschedule.
Authorization Requirements
User privileges: campaign:send
Authorization scopes: campaign_data
Example Delete Schedule Call
This example DELETE call unschedules an email campaign activity.
DELETE https://api.cc.email/v3/emails/activities/{campaign_activity_id}/schedules
<?php
$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/emails/activities/3cfe7b98-3633-4065-950e-de0baeb17563/schedules');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders(array(
'Postman-Token' => '629c91f1-0533-4701-9ba4-7dea3604c185',
'cache-control' => 'no-cache',
'Authorization' => 'Bearer {access_token}'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.cc.email/v3/emails/activities/3cfe7b98-3633-4065-950e-de0baeb17563/schedules")
.delete(null)
.addHeader("Authorization", "Bearer {access_token}")
.addHeader("cache-control", "no-cache")
.addHeader("Postman-Token", "cd923c42-9ac9-4425-a310-9a048a55ef35")
.build();
Response response = client.newCall(request).execute();
curl -X DELETE \
https://api.cc.email/v3/emails/activities/3cfe7b98-3633-4065-950e-de0baeb17563/schedules \
-H 'Authorization: Bearer {access_token}' \
-H 'Postman-Token: d8bf62d4-0a42-40e2-a970-cbcf6674c8b1' \
-H 'cache-control: no-cache'
Response
A successful request returns a 204 No Content response code without a response body.