Campaigns

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.

post/campaigns/{campaignId}/unschedule

Path parameters

campaignIdstring required

Campaign ID

Response

Campaign returned to draft

successboolean

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

  • 11b6d27ba1de19See the full diff
    • added the new group enum value to the campaign/allOf[subschema #2]/blocks/items/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/children to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/columns to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/gap to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/label to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/layout to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/overlayColor to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/overlayPosition to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/overlayShade to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/blocks/items/padding to the response with the 200 status

      response-optional-property-added

  • c78765f7e84f55See the full diff
    • removed the optional property campaign/allOf[subschema #2]/scheduledTimezone from the response with the 200 status

      response-optional-property-removed

    • removed the optional property campaign/allOf[subschema #2]/sendInRecipientTimezone from the response with the 200 status

      response-optional-property-removed

    • removed the optional property campaign/allOf[subschema #2]/sendTimeOptimization from the response with the 200 status

      response-optional-property-removed

    • removed the optional property campaign/allOf[subschema #2]/sendTimeWindowHours from the response with the 200 status

      response-optional-property-removed

    • removed the optional property campaign/allOf[subschema #2]/spreadOverHours from the response with the 200 status

      response-optional-property-removed

    • added the optional property campaign/allOf[CampaignSummary]/scheduledTimezone to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/sendInRecipientTimezone to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/sendTimeOptimization to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/sendTimeWindowHours to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/spreadOverHours to the response with the 200 status

      response-optional-property-added

    • added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • added the optional property retryable to the response with the 403 status

      response-optional-property-added

    • added the optional property retryable to the response with the 404 status

      response-optional-property-added

    • added the optional property retryable to the response with the 409 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/scheduledTimezone to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/sendInRecipientTimezone to the response with the 200 status

      response-optional-property-added

    • added the optional property code to the response with the 400 status

      response-optional-property-added

    • added the optional property code to the response with the 401 status

      response-optional-property-added

    • added the optional property code to the response with the 403 status

      response-optional-property-added

    • added the optional property code to the response with the 404 status

      response-optional-property-added

    • added the optional property code to the response with the 409 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/shareUrl to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/sendTimeOptimization to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/sendTimeWindowHours to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[subschema #2]/spreadOverHours to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/emailPreset to the response with the 200 status

      response-optional-property-added

    • added the optional property campaign/allOf[CampaignSummary]/emailId to the response with the 200 status

      response-optional-property-added

    • the response property success became optional for the status 400

      response-property-became-optional

    • the response property success became optional for the status 401

      response-property-became-optional

    • the response property success became optional for the status 403

      response-property-became-optional

    • the response property success became optional for the status 404

      response-property-became-optional

    • the response property success became optional for the status 409

      response-property-became-optional