Remove Email Template

API Type

REST

HTTP Method

POST

Description

Removes an email template from the AgilePoint database.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/UpdateEMailTemplate/[mailTemplateID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/UpdateEMailTemplate/[mailTemplateID]

Request Parameters

Name	Description
mailTemplateID	Definition: The unique ID for an email template. Type string Allowed Values: A valid mail template ID.

JavaScript Code Example

$("#btnRemoveEMailTemplate").click(function () {
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/
                  RemoveEMailTemplate/C769BA234EFD421B8B95A525B972E511"
  });
});

Java Code Example

public String RemoveEMailTemplate(String mailTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/RemoveEMailTemplate/"
                       + mailTemplateID;

  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 RemoveEMailTemplate()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/
                         RemoveEMailTemplate/C769BA234EFD421B8B95A525B972E511";

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

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

Output

A Boolean value: True or False.

JSON Response Body Example

True

Supported Versions

AgilePoint BPMS v5.0 R2 and higher