Cancel campaign

Overview

Cancel a campaign owned by the caller's company by setting its status to cancelled.

Prerequisites

• A bearer token. Callable with Account tokens.
• The campaignId of the record you are targeting.

Base URL

Endpoint

POST /api/v1/campaign/{campaignId}/cancel

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Authentication, ACCOUNT-scope group.

• If the id does not belong to your account it returns 400 ("You are not authorized to cancel this campaign").

• Campaigns of type == 'default' cannot be cancelled.

Rate limit

• No rate limit.

Path parameters

Response

• data.status (string) — "success".
• data.message (string) — confirmation text.
• 400 if not owned by the caller, or if the campaign is the default campaign.

200 OK · 200

{
  "data": {
    "status": "success",
    "message": "Campaign cancelled successfully"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/123/cancel" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'