Unschedule campaign
Removes the pending send for a scheduled campaign and returns it to an editable draft. Recurrence is stopped, and the campaign can be edited and scheduled again.
Path parameters
Campaign ID
Response
Campaign returned to draft
Example response
{
"success": true,
"campaign": {
"id": "camp_abc123",
"name": "April Launch",
"type": "email",
"subject": "A quick update",
"emailId": "email_abc123",
"emailPreset": "branded",
"status": "draft",
"labels": [
"edm",
"api"
],
"spreadOverHours": 6,
"sendTimeWindowHours": 12,
"scheduledTimezone": "America/New_York",
"preheader": "Latest product news",
"preheaderText": "Latest product news",
"blocks": [
{
"id": "block_123",
"type": "html",
"content": "<h1>Hello</h1>",
"styles": {
"backgroundColor": "#f8fafc",
"backgroundOpacity": 80,
"textColor": "#111827",
"borderRadius": 12,
"borderColor": "#cbd5e1",
"borderWidth": 1
},
"conditions": [
{
"id": "c1",
"value": "plan:pro"
}
]
}
],
"replyProfileId": "reply_abc123",
"replyToName": "Support",
"replyToEmail": "support@example.com",
"shareUrl": "https://sequenzy.com/view/campaign/8f2kL9qWm3ZxYv71TnB4c5RdVaEuGh0s"
}
}Changes
Changed in 14 of the 121 revisions of this API.51435
- ●
added the new
groupenum value to thecampaign/allOf[subschema #2]/blocks/items/typeresponse property for the response status200response-property-enum-value-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/childrento the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/columnsto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/gapto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/labelto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/layoutto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/overlayColorto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/overlayPositionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/overlayShadeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/blocks/items/paddingto the response with the200statusresponse-optional-property-added
- ●
- ●
removed the optional property
campaign/allOf[subschema #2]/scheduledTimezonefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
campaign/allOf[subschema #2]/sendInRecipientTimezonefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
campaign/allOf[subschema #2]/sendTimeOptimizationfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
campaign/allOf[subschema #2]/sendTimeWindowHoursfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
campaign/allOf[subschema #2]/spreadOverHoursfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
campaign/allOf[CampaignSummary]/scheduledTimezoneto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[CampaignSummary]/sendInRecipientTimezoneto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[CampaignSummary]/sendTimeOptimizationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[CampaignSummary]/sendTimeWindowHoursto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[CampaignSummary]/spreadOverHoursto the response with the200statusresponse-optional-property-added
- ●
- ○
added the optional property
retryableto the response with the400statusresponse-optional-property-added
- ○
added the optional property
retryableto the response with the401statusresponse-optional-property-added
- ○
added the optional property
retryableto the response with the403statusresponse-optional-property-added
- ○
added the optional property
retryableto the response with the404statusresponse-optional-property-added
- ○
added the optional property
retryableto the response with the409statusresponse-optional-property-added
- ○
- ○
added the optional property
campaign/allOf[subschema #2]/scheduledTimezoneto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/sendInRecipientTimezoneto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
codeto the response with the400statusresponse-optional-property-added
- ○
added the optional property
codeto the response with the401statusresponse-optional-property-added
- ○
added the optional property
codeto the response with the403statusresponse-optional-property-added
- ○
added the optional property
codeto the response with the404statusresponse-optional-property-added
- ○
added the optional property
codeto the response with the409statusresponse-optional-property-added
- ○
- ○
added the optional property
campaign/allOf[subschema #2]/shareUrlto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
campaign/allOf[subschema #2]/sendTimeOptimizationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/sendTimeWindowHoursto the response with the200statusresponse-optional-property-added
- ○
added the optional property
campaign/allOf[subschema #2]/spreadOverHoursto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
campaign/allOf[CampaignSummary]/emailPresetto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
campaign/allOf[CampaignSummary]/emailIdto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response property
successbecame optional for the status400response-property-became-optional
- ▲
the response property
successbecame optional for the status401response-property-became-optional
- ▲
the response property
successbecame optional for the status403response-property-became-optional
- ▲
the response property
successbecame optional for the status404response-property-became-optional
- ▲
the response property
successbecame optional for the status409response-property-became-optional
- ▲