Cancel a scheduled alert

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

For a number of reasons a scheduled alert may no longer be required. The cancel scheduled alert API allows you to easily remove the schedule alert from the system.

Json sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "scheduledAlertId": "5bc25c23-c1ab-44f4-8fd7-7be1684cb68f"
}

response:
{
    "success": true,
    "returnCode": 200,
    "scheduledAlertId": "5bc25c23-c1ab-44f4-8fd7-7be1684cb68f"
}

Cancelling scheduled alerts

ParameterRequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
scheduledAlertIdMandatoryNoneUnique schedule reference as previously returned by /sendalert, /sendstoredalert or /schedulestoredalert
response:
successOne of “true”, “false”. If false then failureReason should also be returned
scheduledAlertIdAs requested
Back to API guide