OMomnisend
Campaigns

Cancel campaign

Cancel a campaign and mark it as canceled.

Cancelable source states: scheduled or paused (all channel types), or started (email only). Any other status (e.g. draft, sent, canceled) returns 409.

Supported cases:

  • Any scheduled or paused campaign (all channel types)
  • Started email campaigns

Note: For started campaigns, cancellation is best-effort — messages already in flight may still be delivered.

Scopes: campaigns.write

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

post/campaigns/{id}/cancel

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/campaigns/{id}/cancel
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: campaigns.write
    • or API key in header Authorization

Path parameters

idstring required

Campaign ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Campaign cancel initiated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.