v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB

Campaigns

Resume campaign

Resumes a paused campaign. Sending continues with remaining recipients, including A/B test phases when the campaign has a linked test.

post/campaigns/{campaignId}/resume

Path parameters

campaignIdstring required

Campaign ID

Request body

spreadOverHoursinteger nullable

Spread remaining delivery over this many hours. Pass null to clear an existing spread.

Example request

{
  "spreadOverHours": 6
}

Response

Campaign resumed

successboolean

Example response

{
  "success": true,
  "campaign": {
    "id": "camp_abc123",
    "name": "April Launch",
    "type": "email",
    "subject": "A quick update",
    "emailId": "email_abc123",
    "status": "draft",
    "labels": [
      "edm",
      "api"
    ],
    "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"
  }
}