Version: v5.2

Notification Template

Get Notification Templates for an App

Endpoint

GET /passportsvc/api/v1/notification_templates

Request

Parameters

Query

Parameter	Type	Description	Required
`_name`	String	The template's name	Required

Response

Body

{
    "_offset": 0,
    "_pageSize": 2,
    "_total": 2,
    "_list": [
        {
            "_id": "480d7c27-2fd3-609d-31c4-eb572c06e733",
            "_name": "USER_GROUP_INVITE",
            "_title": "Invitation to join a project",
            "_locale": "en",
            "_message": "\n<!doctype html>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\">\n    <head>\n        <!-- NAME: 1 COLUMN -->\n        <!--[if gte mso 15]>\n        <xml>\n            <o:OfficeDocumentSettings>\n            <o:AllowPNG/>\n            <o:PixelsPerInch>96</o:PixelsPerInch>\n            </o:OfficeDocumentSettings>\n        </xml>\n        <![endif]-->\n        <meta charset=\"UTF-8\">\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n        <title>${subject}</title>\n        <style>\n\t\t\t@media only screen and (min-width:768px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 600px !important;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t@media only screen and (max-width:480px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 300px !important;\n\t\t\t\t}\n\t\t\t\t.h1 {\n\t\t\t\t\tfont-size: 22px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.h2 {\n\t\t\t\t\tfont-size: 20px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.p {\n\t\t\t\t\tfont-size: 16px !important;\n\t\t\t\t\tline-height: 150% !important;\n\t\t\t\t}\n\t\t\t\t.logo img {\n\t\t\t\t\twidth: 100% !important;\n\t\t\t\t}\n\t\t\t}\n    \t</style>\n    </head>\n   <body style=\"background-color: #fafafa;\">\n        <div class=\"templateContainer\" style=\"margin: 40px auto; width: 600px; border-radius: 25px 25px; background-color: #FFFFFF; padding-top: 24px; background-size: cover; background-position: center;padding-bottom: 64px;\">\n        \t<div style =\"padding: 9px; text-align: center;\" class=\"logo\">\n        \t\t<img align=\"center\" alt=\"\" src=\"${host}/et/logo.png\" width=\"321.47999999999996\" style=\"max-width:1200px; padding-bottom: 0; display: inline !important; vertical-align: bottom;border: 0; height: auto;outline: none; text-decoration: none;\" class=\"img\">\n        \t</div>\n        \t<div class=\"content\" style=\"padding-top: 0; padding-right: 18px; padding-bottom: 9px; padding-left: 18px; color: #333333; font-family: Helvetica; font-size: 18px; line-height: 150%; text-align: left;\">\n\t        \t<div style=\"padding-top: 9px;\">\n\t\t\t\t\t<h1 class=\"h1\" style=\"display: block;margin: 0;padding: 0;color: #333333; font-family: Helvetica; font-size: 30px; font-style: normal; font-weight: bold; line-height: 150%;letter-spacing: normal;text-align: center;\">${body_header}</h1>\n\t\t\t\t\t<h2 class=\"h2\" style=\"display: block;margin: 0;padding: 0; color: #c71784;font-family: Helvetica;font-size: 30px;font-style: normal;font-weight: bold;line-height: 125%;letter-spacing: normal;text-align: center;\">${name}</h2>\n\t\t\t\t</div>\n\t\t\t\t\n\t\t\t\t<p class=\"p\" style=\"margin: 10px 0; padding: 24px 48px;\">\n\t\t\t\t\t${body_content}\n${new_param}\n\t\t\t\t</p>\n\t\t\t</div>\n\t\t\t<div style=\"margin: 0 auto; text-align: center;\">\n\t\t\t\t<span class=\"button\" style=\" text-align: center;border-collapse: separate !important; border-radius: 11px; background-color: #C71784; font-family: Arial; font-size: 18px; padding: 24px; display: inline-block\">\n\t\t\t\t\t<a  title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\" style=\"font-weight: bold;letter-spacing: normal;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;\">Join Now</a>\n\t\t\t\t</span>\n\t\t\t</div>\n\t\t</div>\n    </body>\n</html>\n",
            "_format": "text/html",
            "_appId": "0f02c817-8655-423e-9d22-5439187078f9",
            "_metadata": {
                "_createdAt": 1624776810273,
                "_updatedAt": 1624873499250,
                "_updatedById": "442abf11-4cf2-41d5-9ec8-dcf9746910c3"
            }
        },
        {
            "_id": "f85cfb9c-643d-ad2c-24e5-3f15fe9cefb2",
            "_name": "USER_GROUP_INVITE_REMINDER",
            "_title": "Reminder: Invitation to join a project",
            "_locale": "en",
            "_message": "\n\t<!doctype html>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\">\n    <head>\n        <!-- NAME: 1 COLUMN -->\n        <!--[if gte mso 15]>\n        <xml>\n            <o:OfficeDocumentSettings>\n            <o:AllowPNG/>\n            <o:PixelsPerInch>96</o:PixelsPerInch>\n            </o:OfficeDocumentSettings>\n        </xml>\n        <![endif]-->\n        <meta charset=\"UTF-8\">\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n        <title>${subject}</title>\n        <style>\n\t\t\t@media only screen and (min-width:768px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 600px !important;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t@media only screen and (max-width:480px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 300px !important;\n\t\t\t\t}\n\t\t\t\t.h1 {\n\t\t\t\t\tfont-size: 22px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.h2 {\n\t\t\t\t\tfont-size: 20px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.p {\n\t\t\t\t\tfont-size: 16px !important;\n\t\t\t\t\tline-height: 150% !important;\n\t\t\t\t}\n\t\t\t\t.logo img {\n\t\t\t\t\twidth: 100% !important;\n\t\t\t\t}\n\t\t\t}\n    \t</style>\n    </head>\n   <body style=\"background-color: #fafafa;\">\n        <div class=\"templateContainer\" style=\"margin: 40px auto; width: 600px; border-radius: 25px 25px; background-color: #FFFFFF; padding-top: 24px; background-size: cover; background-position: center;padding-bottom: 64px;\">\n        \t<div style =\"padding: 9px; text-align: center;\" class=\"logo\">\n        \t\t<img align=\"center\" alt=\"\" src=\"${base_url}/passportsvc/api/et/logo.png\" width=\"321.47999999999996\" style=\"max-width:1200px; padding-bottom: 0; display: inline !important; vertical-align: bottom;border: 0; height: auto;outline: none; text-decoration: none;\" class=\"img\">\n        \t</div>\n        \t<div class=\"content\" style=\"padding-top: 0; padding-right: 18px; padding-bottom: 9px; padding-left: 18px; color: #333333; font-family: Helvetica; font-size: 18px; line-height: 150%; text-align: left;\">\n\t        \t<div style=\"padding-top: 9px;\">\n\t\t\t\t\t<h1 class=\"h1\" style=\"display: block;margin: 0;padding: 0;color: #333333; font-family: Helvetica; font-size: 30px; font-style: normal; font-weight: bold; line-height: 150%;letter-spacing: normal;text-align: center;\">${body_header}: ${name}</h1>\n\t\t\t\t</div>\n\t\t\t\t\n\t\t\t\t<p class=\"p\" style=\"margin: 10px 0; padding: 24px 48px;\">\n\t\t\t\t\tThis is a reminder for the invitation sent on ${invite_dt} - this invitation will expire in 24 hours.\n\t\t\t\t\t<br/><br/>The Digital Twin Administrator for ${name} has invited you to&nbsp;<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\">join the project</a>. \n\t\t\t\t</p>\n\t\t\t</div>\n\t\t\t<div style=\"margin: 0 auto; text-align: center;\">\n\t\t\t\t<span class=\"button\" style=\" text-align: center;border-collapse: separate !important; border-radius: 11px; background-color: #C71784; font-family: Arial; font-size: 18px; padding: 24px; display: inline-block\">\n\t\t\t\t\t<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\" style=\"font-weight: bold;letter-spacing: normal;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;\">Join Now</a>\n\t\t\t\t</span>\n\t\t\t</div>\n\t\t</div>\n    </body>\n</html>\n",
            "_format": "text/html",
            "_appId": "0f02c817-8655-423e-9d22-5439187078f9",
            "_metadata": {
                "_createdAt": 1624776810273,
                "_updatedAt": 1624776810273
            }
        }
    ]
}

Get Notification Template by ID

Endpoint

GET /passportsvc/api/v1/notification_templates/{id}

Request

Parameters

Path

Parameter	Type	Description	Required
`id`	String	The notification template's id	Required

Response

Body

{
    "_id": "f85cfb9c-643d-ad2c-24e5-3f15fe9cefb2",
    "_name": "USER_GROUP_INVITE_REMINDER",
    "_title": "Reminder: Invitation to join a project",
    "_locale": "en",
    "_message": "\n\t<!doctype html>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\">\n    <head>\n        <!-- NAME: 1 COLUMN -->\n        <!--[if gte mso 15]>\n        <xml>\n            <o:OfficeDocumentSettings>\n            <o:AllowPNG/>\n            <o:PixelsPerInch>96</o:PixelsPerInch>\n            </o:OfficeDocumentSettings>\n        </xml>\n        <![endif]-->\n        <meta charset=\"UTF-8\">\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n        <title>${subject}</title>\n        <style>\n\t\t\t@media only screen and (min-width:768px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 600px !important;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t@media only screen and (max-width:480px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 300px !important;\n\t\t\t\t}\n\t\t\t\t.h1 {\n\t\t\t\t\tfont-size: 22px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.h2 {\n\t\t\t\t\tfont-size: 20px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.p {\n\t\t\t\t\tfont-size: 16px !important;\n\t\t\t\t\tline-height: 150% !important;\n\t\t\t\t}\n\t\t\t\t.logo img {\n\t\t\t\t\twidth: 100% !important;\n\t\t\t\t}\n\t\t\t}\n    \t</style>\n    </head>\n   <body style=\"background-color: #fafafa;\">\n        <div class=\"templateContainer\" style=\"margin: 40px auto; width: 600px; border-radius: 25px 25px; background-color: #FFFFFF; padding-top: 24px; background-size: cover; background-position: center;padding-bottom: 64px;\">\n        \t<div style =\"padding: 9px; text-align: center;\" class=\"logo\">\n        \t\t<img align=\"center\" alt=\"\" src=\"${base_url}/passportsvc/api/et/logo.png\" width=\"321.47999999999996\" style=\"max-width:1200px; padding-bottom: 0; display: inline !important; vertical-align: bottom;border: 0; height: auto;outline: none; text-decoration: none;\" class=\"img\">\n        \t</div>\n        \t<div class=\"content\" style=\"padding-top: 0; padding-right: 18px; padding-bottom: 9px; padding-left: 18px; color: #333333; font-family: Helvetica; font-size: 18px; line-height: 150%; text-align: left;\">\n\t        \t<div style=\"padding-top: 9px;\">\n\t\t\t\t\t<h1 class=\"h1\" style=\"display: block;margin: 0;padding: 0;color: #333333; font-family: Helvetica; font-size: 30px; font-style: normal; font-weight: bold; line-height: 150%;letter-spacing: normal;text-align: center;\">${body_header}: ${name}</h1>\n\t\t\t\t</div>\n\t\t\t\t\n\t\t\t\t<p class=\"p\" style=\"margin: 10px 0; padding: 24px 48px;\">\n\t\t\t\t\tThis is a reminder for the invitation sent on ${invite_dt} - this invitation will expire in 24 hours.\n\t\t\t\t\t<br/><br/>The Digital Twin Administrator for ${name} has invited you to&nbsp;<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\">join the project</a>. \n\t\t\t\t</p>\n\t\t\t</div>\n\t\t\t<div style=\"margin: 0 auto; text-align: center;\">\n\t\t\t\t<span class=\"button\" style=\" text-align: center;border-collapse: separate !important; border-radius: 11px; background-color: #C71784; font-family: Arial; font-size: 18px; padding: 24px; display: inline-block\">\n\t\t\t\t\t<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\" style=\"font-weight: bold;letter-spacing: normal;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;\">Join Now</a>\n\t\t\t\t</span>\n\t\t\t</div>\n\t\t</div>\n    </body>\n</html>\n",
    "_format": "text/html",
    "_appId": "0f02c817-8655-423e-9d22-5439187078f9",
    "_metadata": {
        "_createdAt": 1624776810273,
        "_updatedAt": 1624776810273
    }
}

Update Notification Template

Endpoint

PUT /passportsvc/api/v1/notification_templates/{id}

Request

Path parameters

Parameter	Type	Description	Required
`id`	String	The notification template's id	Required

Body parameters

Parameter	Type	Description	Required
`_name`	String	Enter either `USER_GROUP_INVITE` or `USER_GROUP_INVITE_REMINDER`.	Required
`_message`	String	Enter your message as a Velocity template. To pass variables, enter `${<YOUR-VARIABLE-NAME>}` in the message. To pass values to the variables, pass your key-value pairs in the `_params` value for a usergroup invite.	Required
`_title`	Enter a notification title as a string. To pass variables, see _message.	Required
`_locale`	String	Enter the locale value for the template

Body example

{
  "_title": "Welcome to the project: ${project}",
  "_name": "USER_GROUP_INVITE",
  "_format": "text/html",
  "_locale":"en",
  "_message": "\n\t<!doctype html>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\">\n    <head>\n        <!-- NAME: 1 COLUMN -->\n        <!--[if gte mso 15]>\n        <xml>\n            <o:OfficeDocumentSettings>\n            <o:AllowPNG/>\n            <o:PixelsPerInch>96</o:PixelsPerInch>\n            </o:OfficeDocumentSettings>\n        </xml>\n        <![endif]-->\n        <meta charset=\"UTF-8\">\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n        <title>${subject}</title>\n        <style>\n\t\t\t@media only screen and (min-width:768px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 600px !important;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t@media only screen and (max-width:480px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 300px !important;\n\t\t\t\t}\n\t\t\t\t.h1 {\n\t\t\t\t\tfont-size: 22px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.h2 {\n\t\t\t\t\tfont-size: 20px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.p {\n\t\t\t\t\tfont-size: 16px !important;\n\t\t\t\t\tline-height: 150% !important;\n\t\t\t\t}\n\t\t\t\t.logo img {\n\t\t\t\t\twidth: 100% !important;\n\t\t\t\t}\n\t\t\t}\n    \t</style>\n    </head>\n   <body style=\"background-color: #fafafa;\">\n        <div class=\"templateContainer\" style=\"margin: 40px auto; width: 600px; border-radius: 25px 25px; background-color: #FFFFFF; padding-top: 24px; background-size: cover; background-position: center;padding-bottom: 64px;\">\n        \t<div style =\"padding: 9px; text-align: center;\" class=\"logo\">\n        \t\t<img align=\"center\" alt=\"\" src=\"${base_url}/passportsvc/api/et/logo.png\" width=\"321.47999999999996\" style=\"max-width:1200px; padding-bottom: 0; display: inline !important; vertical-align: bottom;border: 0; height: auto;outline: none; text-decoration: none;\" class=\"img\">\n        \t</div>\n        \t<div class=\"content\" style=\"padding-top: 0; padding-right: 18px; padding-bottom: 9px; padding-left: 18px; color: #333333; font-family: Helvetica; font-size: 18px; line-height: 150%; text-align: left;\">\n\t        \t<div style=\"padding-top: 9px;\">\n\t\t\t\t\t<h1 class=\"h1\" style=\"display: block;margin: 0;padding: 0;color: #333333; font-family: Helvetica; font-size: 30px; font-style: normal; font-weight: bold; line-height: 150%;letter-spacing: normal;text-align: center;\">${body_header}: ${name}</h1>\n\t\t\t\t</div>\n\t\t\t\t\n\t\t\t\t<p class=\"p\" style=\"margin: 10px 0; padding: 24px 48px;\">\n\t\t\t\t\tThis is a reminder for the invitation sent on ${invite_dt} - this invitation will expire in ${hours} hours.\n\t\t\t\t\t<br/><br/>The Digital Twin Administrator for ${name} has invited you to&nbsp;<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\">join the project</a>. \n\t\t\t\t</p>\n\t\t\t</div>\n\t\t\t<div style=\"margin: 0 auto; text-align: center;\">\n\t\t\t\t<span class=\"button\" style=\" text-align: center;border-collapse: separate !important; border-radius: 11px; background-color: #C71784; font-family: Arial; font-size: 18px; padding: 24px; display: inline-block\">\n\t\t\t\t\t<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\" style=\"font-weight: bold;letter-spacing: normal;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;\">Join Now</a>\n\t\t\t\t</span>\n\t\t\t</div>\n\t\t</div>\n    </body>\n</html>\n"
}

Response

Response codes

Code	Description
`200`	Success

Response data example

{
  "_id": "bb1d9205-ad30-496c-9327-cec2f40fc7de",
  "_name": "USER_GROUP_INVITE",
  "_title": "Welcome to the project",
  "_locale":"en",
  "_message": "\n\t<!doctype html>\n<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\">\n    <head>\n        <!-- NAME: 1 COLUMN -->\n        <!--[if gte mso 15]>\n        <xml>\n            <o:OfficeDocumentSettings>\n            <o:AllowPNG/>\n            <o:PixelsPerInch>96</o:PixelsPerInch>\n            </o:OfficeDocumentSettings>\n        </xml>\n        <![endif]-->\n        <meta charset=\"UTF-8\">\n        <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n        <title>${subject}</title>\n        <style>\n\t\t\t@media only screen and (min-width:768px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 600px !important;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t@media only screen and (max-width:480px) {\n\t\t\t\t.templateContainer {\n\t\t\t\t\twidth: 300px !important;\n\t\t\t\t}\n\t\t\t\t.h1 {\n\t\t\t\t\tfont-size: 22px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.h2 {\n\t\t\t\t\tfont-size: 20px !important;\n\t\t\t\t\tline-height: 125% !important;\n\t\t\t\t}\n\t\t\t\t.p {\n\t\t\t\t\tfont-size: 16px !important;\n\t\t\t\t\tline-height: 150% !important;\n\t\t\t\t}\n\t\t\t\t.logo img {\n\t\t\t\t\twidth: 100% !important;\n\t\t\t\t}\n\t\t\t}\n    \t</style>\n    </head>\n   <body style=\"background-color: #fafafa;\">\n        <div class=\"templateContainer\" style=\"margin: 40px auto; width: 600px; border-radius: 25px 25px; background-color: #FFFFFF; padding-top: 24px; background-size: cover; background-position: center;padding-bottom: 64px;\">\n        \t<div style =\"padding: 9px; text-align: center;\" class=\"logo\">\n        \t\t<img align=\"center\" alt=\"\" src=\"${base_url}/passportsvc/api/et/logo.png\" width=\"321.47999999999996\" style=\"max-width:1200px; padding-bottom: 0; display: inline !important; vertical-align: bottom;border: 0; height: auto;outline: none; text-decoration: none;\" class=\"img\">\n        \t</div>\n        \t<div class=\"content\" style=\"padding-top: 0; padding-right: 18px; padding-bottom: 9px; padding-left: 18px; color: #333333; font-family: Helvetica; font-size: 18px; line-height: 150%; text-align: left;\">\n\t        \t<div style=\"padding-top: 9px;\">\n\t\t\t\t\t<h1 class=\"h1\" style=\"display: block;margin: 0;padding: 0;color: #333333; font-family: Helvetica; font-size: 30px; font-style: normal; font-weight: bold; line-height: 150%;letter-spacing: normal;text-align: center;\">${body_header}: ${name}</h1>\n\t\t\t\t</div>\n\t\t\t\t\n\t\t\t\t<p class=\"p\" style=\"margin: 10px 0; padding: 24px 48px;\">\n\t\t\t\t\tThis is a reminder for the invitation sent on ${invite_dt} - this invitation will expire in {$hours} hours.\n\t\t\t\t\t<br/><br/>The Digital Twin Administrator for ${name} has invited you to&nbsp;<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\">join the project</a>. \n\t\t\t\t</p>\n\t\t\t</div>\n\t\t\t<div style=\"margin: 0 auto; text-align: center;\">\n\t\t\t\t<span class=\"button\" style=\" text-align: center;border-collapse: separate !important; border-radius: 11px; background-color: #C71784; font-family: Arial; font-size: 18px; padding: 24px; display: inline-block\">\n\t\t\t\t\t<a title=\"Join Now\" href=\"${invite_link}\" target=\"_blank\" style=\"font-weight: bold;letter-spacing: normal;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;\">Join Now</a>\n\t\t\t\t</span>\n\t\t\t</div>\n\t\t</div>\n    </body>\n</html>\n",
  "_format": "text/html",
  "_appId": "0f02c817-8655-423e-9d22-5439187078f9",
  "_metadata": {
    "_createdAt": 1624874726689,
    "_updatedAt": 1624875052823,
    "_createdById": "442abf11-4cf2-41d5-9ec8-dcf9746910c3",
    "_updatedById": "442abf11-4cf2-41d5-9ec8-dcf9746910c3"
  }
}

Delete Notification Template

DELETE /passportsvc/api/v1/notification_templates/{id}

Request

Path parameters

Parameter	Type	Description	Required
`id`	String	The notification template's id	Required

Response

Response codes

Code	Description
`204`	No Content

<!--

Create Notification Templates

Endpoint

POST /passportsvc/api/v1/notification_templates

Parameters

Body

[
    {
        "_title": "Welcome",
        "_name": "WELCOME_EMAIL",
        "_format": "text/html",
        "_message": "<html><body>Welcome ${attr_in_req}</body></html>"
    }
]

_name is unique within an app
The values within ${} are attributes that can be used as dynamic while triggering the notification each time

Response Codes

201 - created

Resposne

{
    "_offset": 0,
    "_pageSize": 1,
    "_total": 1,
    "_list": [
        {
            "_id": "bb1d9205-ad30-496c-9327-cec2f40fc7de",
            "_name": "WELCOME_EMAIL",
            "_title": "Welcome",
            "_message": "<html><body>Welcome ${attr_in_req}</body></html>",
            "_format": "text/html",
            "_appId": "0f02c817-8655-423e-9d22-5439187078f9",
            "_metadata": {
                "_createdAt": 1624874726689,
                "_updatedAt": 1624874726689,
                "_createdById": "442abf11-4cf2-41d5-9ec8-dcf9746910c3",
                "_updatedById": "442abf11-4cf2-41d5-9ec8-dcf9746910c3"
            }
        }
    ]
}

-->

Get Notification Templates for an App​

Endpoint​

Request​

Parameters​

Query​

Response​

Body​

Get Notification Template by ID​

Endpoint​

Request​

Parameters​

Path​

Response​

Body​

Update Notification Template​

Endpoint​

Request​

Path parameters​

Body parameters​

Body example​

Response​

Response codes​

Response data example​

Delete Notification Template​

Request​

Path parameters​

Response​

Response codes​

Create Notification Templates​

Endpoint​

Parameters​

Body​

Response Codes​

Resposne​

Get Notification Templates for an App

Endpoint

Request

Parameters

Query

Response

Body

Get Notification Template by ID

Endpoint

Request

Parameters

Path

Response

Body

Update Notification Template

Endpoint

Request

Path parameters

Body parameters

Body example

Response

Response codes

Response data example

Delete Notification Template

Request

Path parameters

Response

Response codes

Create Notification Templates

Endpoint

Parameters

Body

Response Codes

Resposne