Update Email Template

API Type

REST

HTTP Method

POST

Description

Updates an email template in the AgilePoint database.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
MailTemplateID	Definition: The unique ID for an email template. Type string Allowed Values: A valid mail template ID.
MailTemplateXML	Definition: The XML for an email template. Type string Allowed Values: Valid XML that represents an email template.
TemplateModifiedUserName	Definition: Specifies qualified username for the modified email template. Type string Allowed Values: A valid user name.

JavaScript Code Example

$("#btnUpdateEMailTemplate").click(function () {
  var JSONObject = {
    MailTemplateID: "C769BA234EFD421B8B95A525B972E511",
    TemplateModifiedUserName: "demo3\\admin",
    MailTemplateXML: "<email template XML data>"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/UpdateEMailTemplate",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String UpdateEMailTemplate() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/UpdateEMailTemplate";

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

  JSONObject postData = new JSONObject();
  
    postData.put("MailTemplateID", "XYZ82AAE37054A1AB469FB480028A7A3");
    postData.put("TemplateModifiedUserName", "demo3\\admin");
    postData.put("MailTemplateXML", "<email template xml data>");
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UpdateEMailTemplate()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Admin/UpdateEMailTemplate";

    string jsonRequestData = "{
      \"TemplateOwnerID\":\"" + null + "\", 
      \"MailTemplateXML\":\"" + '<process template XML string>' + "\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

Output

A Boolean value: True or False.

JSON Response Body Example

True

Supported Versions

AgilePoint BPMS v5.0 R2 and higher