Cancel campaign

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

Auth: Account — 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.

Request

Response{ data. } envelope. data is { status: "success", message: "Campaign cancelled successfully" }.

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

Path params

ParameterTypeRequiredNotes
campaignIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json