Cancel a scheduled message

Encoding : UTF-8

Authentication

Your "api-key" and "api-login" identifiers must be added in the headers.

Definition

If you have a waiting draft campaign, or a scheduled campaign, this web service will allow you to cancel it.
Cancellation is only allowed when the campaign has fewer than 3 recipients.
Cancellation is limited to 1000 requests per month and per API user account.
Waiting campaigns must still be scheduled more than 10 minutes in the future.

Parameters

NameTypeDescription
channelstringChannel of the campaign to cancel ['sms', 'voice_sms', 'rcs', 'email']
ticket_numberstringThis the value representing the ticket number of the campaign you want to cancel
Body Params

Payload for cancel multichannel campaign.

string
enum
required
Allowed:
string
required
Headers
string
required

Your api login from your account

string
required

Your api key from your account

Responses
204

Campaign canceled.

400

Bad request.

401

Unauthorized.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!