Cancel Mail Deliverable

API Type

REST

HTTP Method

POST

Description

Cancels the failed mail deliverable record based on a given message identifier. Note that canceling the failed mail deliverable record prevents it from being recycled or present on a given interval by the AgilePoint engine.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/CancelMailDeliverable/[mailID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/CancelMailDeliverable/[mailID]

Request Parameters

Name	Description
mailID	Definition: Specifies the unique ID for an email notification. Type string Allowed Values: A valid email notification ID.

JavaScript Code Example

$("#btnCancelMailDeliverable").click(function () {

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                CancelMailDeliverable/31C364347D364D0AA2EB2853340CA25D",
  });
});

Java Code Example

public String CancelMailDeliverable(String mailID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/CancelMailDeliverable/"
                       + mailID;

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  JSONObject postData = new JSONObject();

  return ops.POSTMethod(URI, postData.toString());
}

C# Code Example

public string CancelMailDeliverable()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         CancelMailDeliverable/4802495DCA8840EFAEE2943028EFAFEE";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URI, "");
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher