Update Global Email Template

API Type

REST

HTTP Method

POST

Description

Updates a global e-mail template to the database.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

MailTemplateID
Function:
The unique ID for an email template.
Type
string
Accepted Values:
A valid mail template ID.

MailTemplateXML
Function:
The XML for an email template.
Type
string
Accepted Values:
Valid XML that represents an email template.

TemplateModifiedUserName
Function:
Specifies qualified username for the modified email template.
Type
string
Accepted Values:
A valid user name.

JavaScript Code Example

$("#btnUpdateEMailTemplate").click(function () {
  var JSONObject = {
    MailTemplateID: "C769BA234EFD421B8B95A525B972E511",
    TemplateModifiedUserName: "mydomain\\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", "mydomain\\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 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.