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.

Good to Know

This API call sets an e-mail status to Cancelled.
To call this method, the API account user must have the access right, Resend and Cancel an Email Notification.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

Name	Description
mailID	Description: 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",
    dataType: "text"
  });
});

Java Code Example

public String CancelMailDeliverable() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        CancelMailDeliverable/AAA82AAE37054A1AB469FB480028A7A3";

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

  JSONObject postData = new JSONObject();

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

C# Code Example

public string CancelMailDeliverable()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         CancelMailDeliverable/AAA82AAE37054A1AB469FB480028A7A3";

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

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

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.

curl --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         -X POST -d '{"MAILID":"{827128D244B4F4D9117760CA3A2ECA05}"}' 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         CancelMailDeliverable/827128D244B4F4D9117760CA3A2ECA05

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.