External Email Template Controller

getMacros

MethodGET
Prod URLhttps://irm.trustarc.com/server/api/v1/external/email-templates/macros
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersRequired Query Parameters
NameValueDescription
templateTypeEmail TypesEmail Types available in IRM
Sample RequestN/A
Sample Success Response
[
  {
    "displayName": "Company Name",
    "macro": "[[${companyName}]]"
  },
  …
]
Success ResponseCode: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

 

getByRequestBestMatches

MethodGET
Prod URLhttps://irm.trustarc.com/server/api/v1/external/email-templates/requests/{requestId}/best-matches
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
URL ParametersRequired Query Parameters
NameValueDescription
requestIdRequest IDRequest where the resulting best matching email templates will be based on.
templateTypeEmail Template TypeEmail Template where the resulting best matching email templates will be based on.
Sample RequestN/A
Sample Success Response
[
  {
    "id": "690c5461-5060-48ea-8825-1834a8f77f28",
    "customFrom": "IRM Notification",
    "replyTo": "no-reply@trustarc.com",
    "subject": "Notification regarding your request to [[${companyName}]]",
    "message": "<div>\n    <span>Hi [[${firstName}]]</span>,\n</div>\n<div>\n    <p>Thank you for your request of [[${requestType}]].</p>\n    <p>Please click this link and download the attachment for more information. <br/><a href=\"[[${downloadLink}]]\">[[${downloadLink}]]</a></p>\n    <p>Please do not reply to this email. If you have further questions or require further assistance please email <strong>[[${companyName}]]</strong> at [[${supportEmail}]].</p>\n</div>\n<div>\n    <p>Thank you.</p>\n</div>"
  },
  …
]
Success ResponseCode: 200 OK
Error Response

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found