{ "info": { "_postman_id": "ffc074f8-78de-47a5-8df0-8b790f3b59dc", "name": "ThingsBoard Admin admin-controller notification-template-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-ffc074f8-78de-47a5-8df0-8b790f3b59dc" }, "item": [ { "name": "api", "item": [ { "name": "notification", "item": [ { "name": "template", "item": [ { "name": "{id}", "item": [ { "name": "Get Notification Template by Id (getNotificationTemplateById)", "id": "2027d737-0248-4f11-a87e-15f3fd6a5e35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/template/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template", ":id" ], "variable": [ { "id": "8921f9aa-5b71-4d7f-b778-481f73595e11", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Fetches notification template by id.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "1c722e98-923f-495e-b7ad-eac1d77b0106", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/template/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"dolore_2\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RESOURCES_SHORTAGE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-1c722e98-923f-495e-b7ad-eac1d77b0106" } ], "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-2027d737-0248-4f11-a87e-15f3fd6a5e35" }, { "name": "Delete Notification Template by Id (deleteNotificationTemplateById", "id": "b705935b-0c05-43c3-9f8c-94ed4995d8f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/template/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template", ":id" ], "variable": [ { "id": "0be01611-8ed4-4b51-ba4e-80d40e0b5a30", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Deletes notification template by its id.\n\nThis template cannot be referenced by existing scheduled notification requests or any notification rules.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "ca3bb97b-877b-4d0b-9f49-176835b41a16", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/notification/template/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-ca3bb97b-877b-4d0b-9f49-176835b41a16" } ], "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-b705935b-0c05-43c3-9f8c-94ed4995d8f0" } ], "id": "aeda626d-4a2a-45ec-98ce-8ea2f913c442", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-aeda626d-4a2a-45ec-98ce-8ea2f913c442" }, { "name": "Save Notification Template (saveNotificationTemplate)", "id": "42958793-f767-4a9e-a0c3-18a686b8fd62", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"dolore_2\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RESOURCES_SHORTAGE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/template", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template" ] }, "description": "Creates or updates notification template.\n\nHere is an example of template to send notification via Web, SMS and Slack:\n```json\n{\n \"name\": \"Greetings\",\n \"notificationType\": \"GENERAL\",\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"WEB\": {\n \"enabled\": true,\n \"subject\": \"Greetings\",\n \"body\": \"Hi there, ${recipientTitle}\",\n \"additionalConfig\": {\n \"icon\": {\n \"enabled\": true,\n \"icon\": \"back_hand\",\n \"color\": \"#757575\"\n },\n \"actionButtonConfig\": {\n \"enabled\": false\n }\n },\n \"method\": \"WEB\"\n },\n \"SMS\": {\n \"enabled\": true,\n \"body\": \"Hi there, ${recipientTitle}\",\n \"method\": \"SMS\"\n },\n \"SLACK\": {\n \"enabled\": true,\n \"body\": \"Hi there, @${recipientTitle}\",\n \"method\": \"SLACK\"\n }\n }\n }\n}\n```\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "d1b810cc-3dac-42b0-8936-9ef803aca107", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"dolore_2\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RESOURCES_SHORTAGE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notification/template", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "template" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"dolore_2\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RESOURCES_SHORTAGE\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-d1b810cc-3dac-42b0-8936-9ef803aca107" } ], "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-42958793-f767-4a9e-a0c3-18a686b8fd62" } ], "id": "124ca2f2-fd33-4b78-ac7a-a6f26598edca", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-124ca2f2-fd33-4b78-ac7a-a6f26598edca" }, { "name": "templates", "item": [ { "name": "Get Notification Templates (getNotificationTemplates)", "id": "a3d6fcb3-5d27-47d1-aecd-fbd6e924a4ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/templates?pageSize=&page=&textSearch=&sortProperty=&sortOrder=¬ificationTypes=¬ificationTypes=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "templates" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on template's name and notification type", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "description": "Comma-separated list of notification types to filter the templates", "key": "notificationTypes", "value": "" }, { "description": "Comma-separated list of notification types to filter the templates", "key": "notificationTypes", "value": "" } ] }, "description": "Returns the page of notification templates owned by sysadmin or tenant.\n\nYou can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "6887f53c-9a0c-4629-bea7-98537527b6c2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/templates?pageSize=&page=&textSearch=&sortProperty=&sortOrder=¬ificationTypes=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "templates" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Case-insensitive 'substring' filter based on template's name and notification type", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "" }, { "description": "Comma-separated list of notification types to filter the templates", "key": "notificationTypes", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"nisi521\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"ipsum6_b\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n },\n \"consecteturd\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"RATE_LIMITS\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n },\n {\n \"configuration\": {\n \"deliveryMethodsTemplates\": {\n \"minim_d83\": {\n \"body\": \"\",\n \"method\": \"\",\n \"subject\": \"\",\n \"enabled\": \"\"\n }\n }\n },\n \"name\": \"\",\n \"notificationType\": \"ENTITIES_LIMIT\",\n \"id\": {\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-6887f53c-9a0c-4629-bea7-98537527b6c2" } ], "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-a3d6fcb3-5d27-47d1-aecd-fbd6e924a4ac" } ], "id": "256899ff-58c9-46e4-93a4-dc56f0a96843", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-256899ff-58c9-46e4-93a4-dc56f0a96843" }, { "name": "slack", "item": [ { "name": "conversations", "item": [ { "name": "List Slack Conversations (listSlackConversations)", "id": "28046817-73b5-4116-8c87-380782f8c3f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/slack/conversations?type=PUBLIC_CHANNEL&token=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "slack", "conversations" ], "query": [ { "description": "(Required) ", "key": "type", "value": "PUBLIC_CHANNEL" }, { "description": "Slack bot token. If absent - system Slack settings will be used", "key": "token", "value": "" } ] }, "description": "List available Slack conversations by type.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, "response": [ { "id": "4dd53ef2-e22f-46b6-8867-c6a41eef008e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notification/slack/conversations?type=PUBLIC_CHANNEL&token=", "host": [ "{{baseUrl}}" ], "path": [ "api", "notification", "slack", "conversations" ], "query": [ { "description": "(Required) ", "key": "type", "value": "PUBLIC_CHANNEL" }, { "description": "Slack bot token. If absent - system Slack settings will be used", "key": "token", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"PRIVATE_CHANNEL\",\n \"wholeName\": \"\",\n \"email\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"PUBLIC_CHANNEL\",\n \"wholeName\": \"\",\n \"email\": \"\",\n \"title\": \"\"\n }\n]", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-4dd53ef2-e22f-46b6-8867-c6a41eef008e" } ], "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-28046817-73b5-4116-8c87-380782f8c3f6" } ], "id": "919cbf98-a366-4845-928a-5cb2ec4dd07c", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-919cbf98-a366-4845-928a-5cb2ec4dd07c" } ], "id": "2a1413d0-34b2-426f-845b-5748fb21214f", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-2a1413d0-34b2-426f-845b-5748fb21214f" } ], "id": "a150f58e-db0c-4153-8a03-94782f51867e", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-a150f58e-db0c-4153-8a03-94782f51867e" } ], "id": "050b7466-817c-4520-baa8-42d9ede12065", "createdAt": "2026-07-28T03:12:57.000Z", "updatedAt": "2026-07-28T03:12:57.000Z", "uid": "35240-050b7466-817c-4520-baa8-42d9ede12065" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }