Cancel an alert

https://api.alert.alertinghub.co.uk/api/json/cancelalert

For a number of reasons it may be desirable to cancel an alert as it is progressing. The cancel alert API attempts to stop an ongoing live alert but please note: this will only ever be partially successful; any messages or calls already being serviced or that have already been sent cannot be cancelled or recalled.

Json sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "alertId": "f1a79b4c-15a2-4d9b-91ec-858afa63c8c5",
    "cancel": [
        {
            "alertType": "sms"
        },
        {
            "alertType": "email"
        },
        {
            "alertType": "call"
        }
    ]
}

Cancelling alerts

Parameter RequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
alertIdMandatoryNoneAlertId previously returned by /sendalert or /sendstoredalert
cancelMandatoryArray of alertType to be cancelled
 -- alertTypeMandatoryThe type of alert to cancel one of: "sms", "email","call"