{"info":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","description":"<html><head></head><body><h1 id=\"get-started-here\">🚀 Get started here</h1>\n<p>EngageNest is the world's leading experience as a platform, enabling organisations to enhance business applications with real-time communication features like voice, video and messaging through API.</p>\n<h3 id=\"what-you-need-to-get-started\">What you need to get started</h3>\n<ul>\n<li><p><strong>Product knowledge.</strong> Check out for Help Center for basics.</p>\n</li>\n<li><p><strong>EngageNest account. Have access to an account and check your plan's limits</strong></p>\n</li>\n<li><p><strong>Tenant Id and Api Key - Please contact support team to get your tenant id and API key</strong></p>\n</li>\n</ul>\n<h3 id=\"authentication\">Authentication</h3>\n<p>Our API uses API keys to authenticate requests. Each request must include your API key in the request header.</p>\n<h4 id=\"making-authenticated-requests\">Making Authenticated Requests</h4>\n<p>To authenticate an API request, include your API key in the header of each request using the following format:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">curl -X GET 'https://api-01.engagenest.com/v1/sms/send' \\\n     -H 'X-EN-Api-Key: YOUR_API_KEY'\n\n</code></pre>\n<p>Replace <code>YOUR_API_KEY</code> with your actual API key.</p>\n<h3 id=\"security-recommendations\">Security recommendations</h3>\n<p>The API access key functions as the authentication token for API operations, necessitating rigorous security management. It is imperative to accord the same level of confidentiality to your API access keys as you would to your passwords. Secure storage and the avoidance of sharing these keys are essential practices.</p>\n<p>A prevalent oversight involves the accidental exposure of API keys through their inclusion in publicly accessible repositories on platforms such as GitHub. Such exposures can attract malicious entities who might misuse these keys to send unauthorized messages or exhaust service credits. To prevent such incidents, it is advisable to adopt strategies like storing API keys in environment variables, passing them through command line arguments, or employing a secrets management tool. It is critical to avoid embedding API keys directly into source code or committing them into public version control repositories.</p>\n<p>Additionally, when sharing code snippets on platforms like PasteBin, GitHub Gists, or StackOverflow, there is a risk of inadvertently disclosing API access keys. It is vital for both you and your developers to be cognizant of this vulnerability and implement appropriate safeguards to mitigate it.</p>\n<p>You'll find more details on these and other topics as you navigate this developer site, so let's dive in.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🚀 Get started here","slug":"get-started-here"}],"owner":"43562343","collectionId":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","publishedId":"2sB2cPiQJt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-01T06:09:48.000Z"},"item":[{"name":"Messages","item":[{"name":"SMS","item":[{"name":"Send","id":"693d49e2-5f84-4c95-9cd5-065de78d27f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"from\": \"S-MART\",\n    \"to\": \"98XXXXXXXX\",\n    \"country\": \"IN\",\n    \"body\": \"message body\",\n    \"templateId\": \"1234567890123456\",\n    \"entityId\": \"9876543210123456\",\n    \"messageType\": 0,\n    \"customId\": \"<your custom id>\",\n    \"metadata\": {\n        \"<custom key 1>\": \"<custom value 1>\",\n        \"<custom key 2>\": \"<custom value 2>\",\n        \"<custom key 3>\": \"<custom value 3>\"\n    },\n    \"flash\": false,\n    \"serviceType\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://services.engagenest.com/core/v1/sms/<tenant id>/send","description":"<p>This endpoint is designed for sending SMS messages within the India region. It allows users to send a text message to a specified phone number with additional parameters for compliance and tracking.</p>\n<h4 id=\"route-parameters\">Route parameters</h4>\n<ul>\n<li><code>tenantId</code> - Tenant Id. Please contact support team to get your tenant Id.</li>\n</ul>\n<h4 id=\"body-parameters\">Body parameters</h4>\n<ul>\n<li><code>from</code> (string, required): The sender ID that will be displayed on the recipient's device. This should be registered and approved as per regulatory requirements.</li>\n<li><code>to</code> (string, required): The recipient's phone number. This should be a valid phone number within the India region. For international messages, phone number should be in E.164 format. ex: +15551235555</li>\n<li><code>country</code> (string, required): Recipient's country. For India, use <code>IN</code> and for international, use <code>INTL.</code></li>\n<li><code>body</code> (string, required): The content of the SMS message to be sent.</li>\n<li><code>templateId</code> (string): Template Id as registered in the Distributed Ledger Technology(DLT) platform, in compliance with TRAI regulations in India. Required field to send messages for Indian receipients.</li>\n<li><code>entityId</code> (string): Entity id as registered in the DLT platform, in compliance with TRAI regulations in India. Required field to send messages for Indian receipients.</li>\n<li><code>messageType</code> (integer, required): The type of message being sent. Possible values are<ul>\n<li><code>0</code> - Text</li>\n<li><code>1</code> - Unicode</li>\n<li><code>2</code> - Auto. System will auto-detect the message type.</li>\n</ul>\n</li>\n<li><code>customId</code> (string, optional): A unique identifier for the message, which can be used for tracking and reference purposes.</li>\n<li><code>metadata</code> (key valu pair, optional ): Key value pair collection to store additional metadata for the request. Maximum of 10 key value pairs are allowed and will be sent back in the delivery status notification callback.</li>\n<li><code>flash</code> (boolean, required): Flag to indicate to process the request as Flash message</li>\n<li><code>serviceType</code>(integer, required): Service type of the message. Possible values are<ul>\n<li><code>0</code> - Transactional</li>\n<li><code>1</code> - Promotional</li>\n<li><code>99</code> - Unknown</li>\n</ul>\n</li>\n</ul>\n<h4 id=\"usage\">Usage</h4>\n<p>To use this endpoint, send a POST request with a JSON payload containing the above parameters. Ensure that all required fields are included in your request. The <code>phoneNumber</code> should be in a format recognized by the Indian telecommunications network. The <code>serviceType</code>, <code>templateId</code>, and <code>entityId</code> should correspond to the registered and approved types and IDs as per the regulatory requirements.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v1","sms","<tenant id>","send"],"host":["https://services.engagenest.com/core"],"query":[],"variable":[]}},"response":[{"id":"2f4b43ba-2464-4604-b78e-1302ad121384","name":"Send","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"from\": \"S-MART\",\n  \"to\": \"98XXXXXXXX\",\n  \"country\": \"IN\",\n  \"body\": \"message body\",\n  \"templateId\": \"1234567890123456\",\n  \"entityId\": \"9876543210123456\",\n  \"messageType\": 0,\n  \"customId\": \"<your custom id>\",\n  \"metadata\": {\n    \"<custom key 1>\": \"<custom value 1>\",\n    \"<custom key 2>\": \"<custom value 2>\",\n    \"<custom key 3>\": \"<custom value 3>\"\n  },\n  \"flash\": true,\n  \"serviceType\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://services.engagenest.com/core/v1/sms/:tenantId/send","host":["https://services.engagenest.com/core"],"path":["v1","sms",":tenantId","send"],"variable":[{"key":"tenantId","value":"","description":"Tenant Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"<unique message identifier>\"\n}"}],"_postman_id":"693d49e2-5f84-4c95-9cd5-065de78d27f4"},{"name":"Personalized Message","id":"7f5de48f-70d1-4920-8c4e-7dad8c951bd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"from\": \"string\",\n  \"to\": \"string\",\n  \"country\": \"string\",\n  \"body\": \"string\",\n  \"templateId\": \"string\",\n  \"entityId\": \"string\",\n  \"messageType\": 0,\n  \"customId\": \"string\",\n  \"metadata\": {\n    \"additionalProp1\": \"string\",\n    \"additionalProp2\": \"string\",\n    \"additionalProp3\": \"string\"\n  },\n  \"flash\": true,\n  \"serviceType\": 0,\n  \"parameters\": {\n    \"additionalProp1\": \"string\",\n    \"additionalProp2\": \"string\",\n    \"additionalProp3\": \"string\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://services.engagenest.com/core/v1/sms/:tenantId/send-personalized","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v1","sms",":tenantId","send-personalized"],"host":["https://services.engagenest.com/core"],"query":[],"variable":[{"id":"fea7f458-9799-4a3c-b6da-72a74637bf5c","type":"any","value":"","key":"tenantId"}]}},"response":[],"_postman_id":"7f5de48f-70d1-4920-8c4e-7dad8c951bd2"},{"name":"Batch messages","id":"a44ef8a6-5976-4f07-a8a1-6e4e68874090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"from\": \"string\",\n  \"to\": [\n    \"string\"\n  ],\n  \"country\": \"string\",\n  \"body\": \"string\",\n  \"templateId\": \"string\",\n  \"entityId\": \"string\",\n  \"messageType\": 0,\n  \"customId\": \"string\",\n  \"metadata\": {\n    \"additionalProp1\": \"string\",\n    \"additionalProp2\": \"string\",\n    \"additionalProp3\": \"string\"\n  },\n  \"flash\": true,\n  \"serviceType\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://services.engagenest.com/core/v1/sms/:tenantId/bulk","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v1","sms",":tenantId","bulk"],"host":["https://services.engagenest.com/core"],"query":[],"variable":[{"id":"5b2cf214-c133-4664-980f-2cabd0094b92","type":"any","value":"","key":"tenantId"}]}},"response":[],"_postman_id":"a44ef8a6-5976-4f07-a8a1-6e4e68874090"},{"name":"Personalized batch messages","id":"cbe70358-951e-4b1e-b32f-41558bd3593b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"from\": \"string\",\n  \"to\": [\n    {\n      \"mobile\": \"string\",\n      \"customId\": \"string\",\n      \"metadata\": {\n        \"additionalProp1\": \"string\",\n        \"additionalProp2\": \"string\",\n        \"additionalProp3\": \"string\"\n      },\n      \"parameters\": {\n        \"additionalProp1\": \"string\",\n        \"additionalProp2\": \"string\",\n        \"additionalProp3\": \"string\"\n      }\n    }\n  ],\n  \"country\": \"string\",\n  \"body\": \"string\",\n  \"templateId\": \"string\",\n  \"entityId\": \"string\",\n  \"messageType\": 0,\n  \"flash\": true,\n  \"serviceType\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://services.engagenest.com/core/v1/sms/:tenantId/bulk-personalized","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v1","sms",":tenantId","bulk-personalized"],"host":["https://services.engagenest.com/core"],"query":[],"variable":[{"id":"511cddee-50cb-4ccb-9cf0-578d7d8c367f","type":"any","value":"","key":"tenantId"}]}},"response":[],"_postman_id":"cbe70358-951e-4b1e-b32f-41558bd3593b"}],"id":"ea9e6e22-dc26-4031-92f5-56e50c39b50c","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2ee82545-f270-447a-a392-37b333d09bc3"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"9ce66d52-5cec-4d20-97a9-e96936e488f2"}}],"_postman_id":"ea9e6e22-dc26-4031-92f5-56e50c39b50c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Sender","item":[{"name":"Retrieve all senders","event":[{"listen":"test","script":{"exec":["","pm.test(\"Set id\", function () {","    console.log(\"Response\", pm.response.json());","    var data = pm.response.json();","    console.log(\"Data\", data);","    console.log(\"Data of the first link\", data.data[0]);","    pm.environment.set(\"id\", data.data[0].id);","});",""],"type":"text/javascript","id":"f7432db3-a149-44f7-9438-8feb70497a24"}}],"id":"1609b6b3-b0d9-4039-9cbe-cc170ae19e2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1609b6b3-b0d9-4039-9cbe-cc170ae19e2c"},{"name":"Retrieve a sender","id":"e9354a40-8cca-40c7-bbfa-ff1e29b24ce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link/:id","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"f92a1ee5-3ae5-4cd8-88e5-66fa1bfea9ce","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e9354a40-8cca-40c7-bbfa-ff1e29b24ce4"},{"name":"Create a new sender","id":"ac5b4aea-0122-4e3e-81de-f8e49d3c6d6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"senderId\": \"ENEST\",\n    \"description\": \"EngageNest sender id\",\n    \"service\": \"MKT\",\n    \"entityId\": \"E123\",\n    \"entityName\": \"EngageNest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.engagenest.com/v1/sender","description":"<p>Register a new sender ID for use in sending messages.</p>\n<h3 id=\"parameters\">Parameters</h3>\n<ul>\n<li><p><code>senderId</code> (string, required): The desired sender ID to be registered.</p>\n</li>\n<li><p><code>description</code> (string, optional): A brief description of the sender ID for reference.</p>\n</li>\n<li><p><code>service</code> (string, required): The type of service (e.g., \"MKT\" for marketing).</p>\n</li>\n<li><p><code>entityId</code> (string, required): The entity ID associated with the sender.</p>\n</li>\n<li><p><code>entityName</code> (string, required): The name of the entity associated with the sender.</p>\n</li>\n</ul>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v1","sender"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac5b4aea-0122-4e3e-81de-f8e49d3c6d6c"},{"name":"Update a new sender","id":"df39cd1c-76f8-41aa-b3e7-8e2b6986d159","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df39cd1c-76f8-41aa-b3e7-8e2b6986d159"},{"name":"Delete a sender","id":"07b929f0-0d71-41c9-826b-e97d22f345b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.engagenest.com/shortener/link/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"a3b99393-023c-4be4-ba45-bdab79cc37e2","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]}},"response":[],"_postman_id":"07b929f0-0d71-41c9-826b-e97d22f345b8"}],"id":"37971049-e53d-4499-b2dd-876e4002184a","_postman_id":"37971049-e53d-4499-b2dd-876e4002184a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Templates","item":[{"name":"Retrieve all templates","event":[{"listen":"test","script":{"exec":["","pm.test(\"Set id\", function () {","    console.log(\"Response\", pm.response.json());","    var data = pm.response.json();","    console.log(\"Data\", data);","    console.log(\"Data of the first link\", data.data[0]);","    pm.environment.set(\"id\", data.data[0].id);","});",""],"type":"text/javascript","id":"cca8eff2-3dc3-49de-a448-af43cb8e1c40"}}],"id":"b3fb2d43-ccec-4d26-8a65-0bfa5498d51f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3fb2d43-ccec-4d26-8a65-0bfa5498d51f"},{"name":"Retrieve a template","id":"27bd34ae-597a-4955-b855-8dfaec2bfdfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link/:id","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"dc5fdbd4-2e18-478e-9b3f-db7de239c45b","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"27bd34ae-597a-4955-b855-8dfaec2bfdfc"},{"name":"Create a new template","id":"6eca0973-39a6-488c-9f99-8a98903a3a73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6eca0973-39a6-488c-9f99-8a98903a3a73"},{"name":"Update a template","id":"8df6848b-542d-46c4-a9c6-677a363793dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8df6848b-542d-46c4-a9c6-677a363793dd"},{"name":"Delete a template","id":"74d13d40-49e0-47ca-98cd-49259f8b7beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.engagenest.com/shortener/link/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"b0bf8aea-11fe-421a-80e0-002aef826682","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]}},"response":[],"_postman_id":"74d13d40-49e0-47ca-98cd-49259f8b7beb"}],"id":"b0ebd405-dd3a-42ad-9bae-e681cbb3db74","_postman_id":"b0ebd405-dd3a-42ad-9bae-e681cbb3db74","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}}],"id":"3fcb11ae-0944-4797-8bc1-897d795eb770","_postman_id":"3fcb11ae-0944-4797-8bc1-897d795eb770","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Links (beta)","item":[{"name":"Retrieve all links","event":[{"listen":"test","script":{"exec":["","pm.test(\"Set id\", function () {","    console.log(\"Response\", pm.response.json());","    var data = pm.response.json();","    console.log(\"Data\", data);","    console.log(\"Data of the first link\", data.data[0]);","    pm.environment.set(\"id\", data.data[0].id);","});",""],"type":"text/javascript","packages":{},"id":"bcf1166d-9e28-4ff4-999a-6551157a828d"}}],"id":"0d08ffee-b833-4e12-b145-b9cc42ac20fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-01.engagenest.com/v2/config/<tenant id>/links/list?pageNumber=1&pageSize=10","description":"<p>This endpoint retrieves all the shortened links for a specific tenant (<code>tenantId</code>).</p>\n<p><strong>Path Parameters</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>tenantId</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The unique identifier of the tenant.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Query Parameters</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>pageNumber</code></td>\n<td><code>integer</code></td>\n<td>No</td>\n<td>The page number for pagination (default: <code>1</code>).</td>\n</tr>\n<tr>\n<td><code>pageSize</code></td>\n<td><code>integer</code></td>\n<td>No</td>\n<td>The number of links per page (default: <code>10</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Responses</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>200 OK</code></td>\n<td>Successfully retrieved the list of links.</td>\n</tr>\n<tr>\n<td><code>404 Not Found</code></td>\n<td>No links found for the provided tenant.</td>\n</tr>\n<tr>\n<td><code>401 Unauthorized</code></td>\n<td>Authentication failed (if applicable).</td>\n</tr>\n<tr>\n<td><code>500 Internal Server Error</code></td>\n<td>An unexpected error occurred.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v2","config","<tenant id>","links","list"],"host":["https://api-01.engagenest.com"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[],"_postman_id":"0d08ffee-b833-4e12-b145-b9cc42ac20fd"},{"name":"Retrieve a link","id":"f80f02b2-7830-40f0-b74f-c18a16acb836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-01.engagenest.com/v2/config/<tenant id>links/demo123","description":"<p>This endpoint retrieves the details of a shortened link using its unique identifier (<code>id</code>).</p>\n<p><strong>Path Parameters</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>tenantId</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Unique identifier of the tenant</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The unique identifier of the shortened link.</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<p><strong>Example Request</strong>:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-http\">GET https://api-01.engagenest.com/v1/config/link/abc123\n\n</code></pre>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v2","config","<tenant id>links","demo123"],"host":["https://api-01.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f80f02b2-7830-40f0-b74f-c18a16acb836"},{"name":"Create a new link","id":"2aa3a320-0b99-4db3-b427-2a80d19047a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"destination_url\": \"https://lawrenceandmayo.com/stores/\",\n  \"token\": \"home\",\n  \"isActive\": true,\n  \"domain\": \"https://entl.in\",\n  \"comments\": \"Home page\",\n  \"sender\": \"LMEYES\",\n  \"expiresAt\": 3600\n}","options":{"raw":{"language":"json"}}},"url":"https://api-01.engagenest.com/v2/config/<tenant id>/links","description":"<h3 id=\"api-documentation-create-shortened-links\">API Documentation: Create Shortened Links</h3>\n<p>This endpoint is used to create a shortened URL within the context of a specific tenant (<code>tenantId</code>).</p>\n<p><strong>Request Body</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>tenantId</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Unique identifier of the tenant</td>\n</tr>\n<tr>\n<td><code>destination_url</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The original URL that the shortened link will redirect to.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>A unique identifier for the link (optional). If not provided, the system will generate one.</td>\n</tr>\n<tr>\n<td><code>isActive</code></td>\n<td><code>boolean</code></td>\n<td>Yes</td>\n<td>Indicates whether the link is active (<code>true</code>) or inactive (<code>false</code>).</td>\n</tr>\n<tr>\n<td><code>domain</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>The domain to be used for the shortened URL (optional). Default will be applied if not provided.</td>\n</tr>\n<tr>\n<td><code>comments</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Any additional comments or metadata about the link.</td>\n</tr>\n<tr>\n<td><code>sender</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Information about the sender creating the link.</td>\n</tr>\n<tr>\n<td><code>expiresAt</code></td>\n<td>double</td>\n<td>No</td>\n<td>Specifies the expiration time of the record in seconds. Used to determine when the record becomes invalid or inaccessible.  <br />  <br />Default value: 30 days from the current time.  <br />  <br />Expected value: Any positive number</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Example Payload</strong>:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"destination_url\": \"https://www.engagenest.com\",\n  \"token\": \"home\",\n  \"isActive\": true,\n  \"domain\": \"https://entl.in\",\n  \"comments\": \"Home page\",\n  \"sender\": \"ENGTST\"\n}\n\n</code></pre>\n<hr />\n<p><strong>Responses</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>201 Created</code></td>\n<td>The link was successfully created.</td>\n</tr>\n<tr>\n<td><code>400 Bad Request</code></td>\n<td>Invalid or missing required parameters.</td>\n</tr>\n<tr>\n<td><code>401 Unauthorized</code></td>\n<td>Authentication failed (if applicable).</td>\n</tr>\n<tr>\n<td><code>500 Internal Server Error</code></td>\n<td>An unexpected error occurred.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v2","config","<tenant id>","links"],"host":["https://api-01.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2aa3a320-0b99-4db3-b427-2a80d19047a3"},{"name":"Delete a link","id":"2912058b-1ebe-4bf0-95d6-e9ef9d0ed8c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-01.engagenest.com/v2/config/<tenant id>/links/lnk052e19cea1e944a1874eca221fc28be8","description":"<p>This endpoint deletes a shortened link using its unique identifier (<code>id</code>).</p>\n<p><strong>Path Parameters</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>tenantId</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Unique identifier of the tenant</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The unique identifier of the shortened link to be deleted.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Responses</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>204 No Content</code></td>\n<td>The link was successfully deleted.</td>\n</tr>\n<tr>\n<td><code>404 Not Found</code></td>\n<td>No link found with the provided identifier.</td>\n</tr>\n<tr>\n<td><code>401 Unauthorized</code></td>\n<td>Authentication failed (if applicable).</td>\n</tr>\n<tr>\n<td><code>500 Internal Server Error</code></td>\n<td>An unexpected error occurred.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["v2","config","<tenant id>","links","lnk052e19cea1e944a1874eca221fc28be8"],"host":["https://api-01.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2912058b-1ebe-4bf0-95d6-e9ef9d0ed8c8"}],"id":"f2691932-90f0-41ad-9217-ad1d04b893f2","description":"<p>Shortener service helps to create short links for the long urls. For example, <a href=\"https://www.entl.in/abcd\">https://www.entl.in/abcd</a> to redirect to <a href=\"https://www.youtube.com/watch?v=R0alThHNb0Y\">https://www.youtube.com/watch?v=R0alThHNb0Y</a></p>\n<p>The <strong>Links Entity</strong> represents the core data model used in the URL shortener service. It encapsulates all the attributes required to create, manage, and retrieve shortened links. Each link is associated with a tenant and is identified by a unique <code>id</code>. The entity includes optional fields to allow customization, such as a domain or token, while ensuring essential data like the destination URL is always present.</p>\n<p><strong>Attributes of the Links Entity</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Attribute</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>A unique identifier for the shortened link, auto-generated by the system.</td>\n</tr>\n<tr>\n<td><code>destination_url</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The original URL to which the shortened link redirects.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>A custom unique token for the link, generated automatically if not provided.</td>\n</tr>\n<tr>\n<td><code>senderId</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Identifier of the sender creating the link, typically used for tracking.</td>\n</tr>\n<tr>\n<td><code>isActive</code></td>\n<td><code>boolean</code></td>\n<td>Yes</td>\n<td>Indicates whether the link is currently active.</td>\n</tr>\n<tr>\n<td><code>domain</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>The domain for the shortened URL. If not specified, the default domain is used.</td>\n</tr>\n<tr>\n<td><code>comments</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>Any additional notes or metadata related to the link.</td>\n</tr>\n<tr>\n<td><code>sender</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Information about the sender creating the link (e.g., team, department).</td>\n</tr>\n<tr>\n<td><code>created_at</code></td>\n<td><code>datetime</code></td>\n<td>Yes</td>\n<td>The timestamp when the link was created.</td>\n</tr>\n<tr>\n<td><code>updated_at</code></td>\n<td><code>datetime</code></td>\n<td>Yes</td>\n<td>The timestamp when the link was last updated.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"f2691932-90f0-41ad-9217-ad1d04b893f2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Campaigns (beta)","item":[{"name":"Retrieve all campaigns","event":[{"listen":"test","script":{"exec":["","pm.test(\"Set id\", function () {","    console.log(\"Response\", pm.response.json());","    var data = pm.response.json();","    console.log(\"Data\", data);","    console.log(\"Data of the first link\", data.data[0]);","    pm.environment.set(\"id\", data.data[0].id);","});",""],"type":"text/javascript","id":"bd823a8f-26b7-4eac-891e-042408ef9cc5"}}],"id":"ba6ccff2-ccc5-4ab7-a163-f136c7f22d52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba6ccff2-ccc5-4ab7-a163-f136c7f22d52"},{"name":"Retrieve a campaign","id":"ac05be87-3cf1-44b9-8a9b-25dfcc34ee93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link/:id","description":"<p>Retrieve a link - updated</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"c41028b5-dd93-43ea-8dc1-aed0fdedc7ee","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ac05be87-3cf1-44b9-8a9b-25dfcc34ee93"},{"name":"Create a new campaign","id":"fbecae35-52cc-48c1-8fe5-28f2ece19272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fbecae35-52cc-48c1-8fe5-28f2ece19272"},{"name":"Update a campaign","id":"72660e82-81a6-4b75-a8c3-c9756574b8d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"72660e82-81a6-4b75-a8c3-c9756574b8d7"},{"name":"Delete a campaign","id":"0ac2a63b-af6f-46eb-84f7-94a2bed33be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.engagenest.com/shortener/link/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"44ed477d-87dc-4923-87de-58a368c3bd79","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"<string>","key":"id"}]}},"response":[],"_postman_id":"0ac2a63b-af6f-46eb-84f7-94a2bed33be3"},{"name":"Start a campaign","id":"68385682-12c2-41e0-9085-72c4ead2fa59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"68385682-12c2-41e0-9085-72c4ead2fa59"},{"name":"Schedule a campaign","id":"a4819d75-ad62-4cdf-b38a-05c317b1e924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"a4819d75-ad62-4cdf-b38a-05c317b1e924"},{"name":"Stop a campaign","id":"f0138894-f719-4a82-adb2-3e6843c83add","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f0138894-f719-4a82-adb2-3e6843c83add"},{"name":"Add a contact to the campaign","id":"8756c34c-ab31-4793-826c-2f893e3d10cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8756c34c-ab31-4793-826c-2f893e3d10cb"},{"name":"Update a contact in the campaign","id":"cca3796f-72b2-4770-8aff-9e3352fccbb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.engagenest.com/link","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["link"],"host":["https://api.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cca3796f-72b2-4770-8aff-9e3352fccbb4"},{"name":"Delete a contact from the campaign","id":"5f8f41b4-ad8b-42f3-8dc3-dd1bcee3f05e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5f8f41b4-ad8b-42f3-8dc3-dd1bcee3f05e"}],"id":"e3add5e5-6c4a-4421-a042-a198ea16286e","_postman_id":"e3add5e5-6c4a-4421-a042-a198ea16286e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Analytics","item":[{"name":"Get site visits for a link","event":[{"listen":"test","script":{"exec":["","pm.test(\"Set id\", function () {","    console.log(\"Response\", pm.response.json());","    var data = pm.response.json();","    console.log(\"Data\", data);","    console.log(\"Data of the first link\", data.data[0]);","    pm.environment.set(\"id\", data.data[0].id);","});",""],"type":"text/javascript","id":"ae41f3df-fb27-4206-be9a-5dfa7e18e97d"}}],"id":"c65c08b5-2a31-4dd8-9dc1-d2e0eb9394c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.engagenest.com/shortener/link/:id","description":"<p>Returns the click counts for the specified link in an array based on a date</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}},"urlObject":{"path":["shortener","link",":id"],"host":["https://api.engagenest.com"],"query":[],"variable":[{"id":"486a421f-6dff-45b4-a8b6-f3f13dd7729b","description":{"content":"<p>Link Id</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"c65c08b5-2a31-4dd8-9dc1-d2e0eb9394c0"}],"id":"1f09ad33-b22e-4981-b32d-01355106b0df","description":"<p>The Analytics API category provides developers with a comprehensive set of tools to access and leverage vital data related to SMS communication. These endpoints are specifically designed to help you monitor, analyze, and optimize your communication product's performance.</p>\n<p>By utilizing the Analytics API, you can gain insights into various aspects of your SMS campaigns, including delivery rates, the effectiveness of short links, and the overall reach of your messages. This data-driven approach allows you to make informed decisions, enhance campaign strategies, and ultimately improve the impact of your SMS communications.</p>\n<p>Whether you're building applications to track SMS performance, assess the success of your campaigns, or understand the behavior of your recipients, the Analytics API category is a valuable resource for developers to harness the full potential of your communication product.</p>\n<p>Explore the detailed endpoint documentation to learn how to make successful API requests and fully utilize the capabilities of the Analytics API.</p>\n","_postman_id":"1f09ad33-b22e-4981-b32d-01355106b0df","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","id":"cdb2bc88-7e25-4a72-b5fe-3b185a32176d","name":"EngageNest API","type":"collection"}}},{"name":"Adapters","item":[{"name":"MobTexting","item":[{"name":"Send SMS","id":"cdaf46a2-6821-4d3e-879c-04fcba55befe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"sender\": \"STARTR\",\n  \"to\": [\n    \"919876543210\",\n    \"919812345678\"\n  ],\n  \"message\": \"Welcome to our service!\",\n  \"service\": \"T\",\n  \"time\": \"2024-11-16T15:00:00Z\",\n  \"type\": \"text\",\n  \"flash\": 0,\n  \"custom\": \"12345\",\n  \"port\": \"8080\",\n  \"entity_id\": \"entity123\",\n  \"template_id\": \"template456\",\n  \"max_units\": 2,\n  \"webhook_id\": \"\",\n  \"meta\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-01.engagenest.com/v2/mt-adapter/sms/send","description":"<p>This endpoint is used to send messages to one or more recipients. It supports customizable options for the message type, delivery timing, and additional metadata.</p>\n<p><strong>Request Body</strong>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>sender</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The sender's identifier (e.g., sender ID, phone number, or name).</td>\n</tr>\n<tr>\n<td><code>to</code></td>\n<td><code>array</code></td>\n<td>Yes</td>\n<td>List of recipient phone numbers in international format.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The message content to be sent.</td>\n</tr>\n<tr>\n<td><code>service</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Specifies the service type (e.g., transactional or promotional).</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>Schedule time for the message in ISO 8601 format. Leave blank for immediate delivery.</td>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The message type (e.g., text, binary, etc.).</td>\n</tr>\n<tr>\n<td><code>flash</code></td>\n<td><code>integer</code></td>\n<td>No</td>\n<td>Indicates if the message should be sent as a flash message (<code>0</code> or <code>1</code>).</td>\n</tr>\n<tr>\n<td><code>custom</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>Custom data for additional information or tracking.</td>\n</tr>\n<tr>\n<td><code>port</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>The port number for specific SMS delivery.</td>\n</tr>\n<tr>\n<td><code>entity_id</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>The registered entity ID for compliance purposes (e.g., DLT compliance). If not avialable, system will set entityId based on the message body</td>\n</tr>\n<tr>\n<td><code>template_id</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>The template ID for pre-approved message content (e.g., for DLT compliance).If not avialable, system will set entityId based on the message body</td>\n</tr>\n<tr>\n<td><code>max_units</code></td>\n<td><code>integer</code></td>\n<td>No</td>\n<td>Maximum units allowed for the message. Defaults to <code>0</code> (no limit).</td>\n</tr>\n<tr>\n<td><code>webhook_id</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>ID for the webhook to trigger upon delivery or status update.</td>\n</tr>\n<tr>\n<td><code>meta</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>Additional metadata for the message in a serialized format.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","name":"Adapters","type":"folder"}},"urlObject":{"path":["v2","mt-adapter","sms","send"],"host":["https://api-01.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdaf46a2-6821-4d3e-879c-04fcba55befe"},{"name":"Send template","id":"ef7600f3-e953-44f8-8cac-fd3a642c6598","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"alias\": \"promotional_template\",\n  \"data\": {\n    \"var1\": \"John\",\n    \"var2\": \"john.doe@example.org\",\n    \"var3\": \"919876543210\"\n  },\n  \"meta\": {\n    \"tags\": [\n      \"tag1\"\n    ],\n    \"webhook_id\": \"7tuytu\",\n    \"foreign_id\": \"12345\",\n    \"service\": \"T\",\n    \"flash\": 0\n  },\n  \"recipient\": {\n    \"to\": [\n      \"919876543210\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-01.engagenest.com/v2/mt-adapter/sms/send/template","description":"<p>This API endpoint makes an HTTP <code>POST</code> request to send a template SMS using the template <code>alias</code> name or template <code>id</code> of the predefined template created in your account to specified recipients.</p>\n<h4 id=\"example-template\">Example Template:</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-bash\">Dear {{var1}}, Thanks for registering with us. Your details as follows {{var2}}, {{var3}}.\n\n</code></pre>\n<p><em><strong>Note:</strong></em> When sending a message, ensure that the data is passed into the data payload. Then the content will be automatically replaced within the template.</p>\n<h4 id=\"output-message\">Output Message:</h4>\n<p><code>Dear John, Thanks for regisitering with us. Your details as follows</code> <a href=\"mailto:john.doe@example.org\">john.doe@example.org</a><code>,</code>919876543210<code>.</code></p>\n<p><em><strong>Note:</strong></em> Few elements in the endpoint may change from service to service.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>alias</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>An alias of the registered template. (Required if id is not present)</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>ID of the registered template. (Required if alias is not present)</td>\n</tr>\n<tr>\n<td><code>data</code></td>\n<td><code>object</code></td>\n<td>Yes</td>\n<td>Key-value pairs of dynamic content to populate the message template. Fields var1, var2 and var3 are given below for the example template. Field names should match with the variable name in the template.</td>\n</tr>\n<tr>\n<td>└ var1</td>\n<td><code>string</code></td>\n<td>No</td>\n<td>Email of the recipient (optional for SMS).</td>\n</tr>\n<tr>\n<td>└ var2</td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Name of the recipient.</td>\n</tr>\n<tr>\n<td>└ var3</td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>Phone number of the recipient.</td>\n</tr>\n<tr>\n<td><code>meta</code></td>\n<td><code>object</code></td>\n<td>No</td>\n<td>Metadata associated with the message for tracking or categorization.</td>\n</tr>\n<tr>\n<td>└ <code>tags</code></td>\n<td><code>array of string</code></td>\n<td>No</td>\n<td>List of tags to classify or group messages.</td>\n</tr>\n<tr>\n<td>└ <code>webhook_id</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>ID of the webhook to be triggered for status or delivery updates.</td>\n</tr>\n<tr>\n<td>└ <code>foreign_id</code></td>\n<td><code>string</code></td>\n<td>No</td>\n<td>External identifier for the message, useful for integration tracking.</td>\n</tr>\n<tr>\n<td>└ <code>service</code></td>\n<td><code>string</code></td>\n<td>Yes</td>\n<td>The service type (<code>T</code> for transactional, etc.).</td>\n</tr>\n<tr>\n<td>└ <code>flash</code></td>\n<td><code>integer</code></td>\n<td>No</td>\n<td>Indicates if the message should be sent as a flash message (<code>0</code> or <code>1</code>).</td>\n</tr>\n<tr>\n<td><code>recipient</code></td>\n<td><code>object</code></td>\n<td>Yes</td>\n<td>Contains details of the message recipient(s).</td>\n</tr>\n<tr>\n<td>└ <code>to</code></td>\n<td><code>array</code></td>\n<td>Yes</td>\n<td>List of recipient phone numbers in international format.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","name":"Adapters","type":"folder"}},"urlObject":{"path":["v2","mt-adapter","sms","send","template"],"host":["https://api-01.engagenest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef7600f3-e953-44f8-8cac-fd3a642c6598"}],"id":"10adaf12-91b5-4742-a853-c016c8e0547e","_postman_id":"10adaf12-91b5-4742-a853-c016c8e0547e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","name":"Adapters","type":"folder"}}}],"id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"604a5120-ed27-4496-a693-e2f588620f8c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"5e437271-0ff6-4120-bf76-7d3122812657"}}],"_postman_id":"04914d6c-5a1e-4dfd-89d9-17eb8395e899","description":""}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-EN-Api-Key"},{"key":"value","value":"{{apiKey}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a184b178-a1b6-4c6d-9e6c-d50a962e9ff2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3ef4df39-24be-494b-818a-93477aa6febc"}}],"variable":[{"key":"id","value":"demo123"},{"key":"base_url","value":"https://api.engagenest.com"},{"key":"sms_base_url","value":"https://services.engagenest.com/core","type":"string"},{"key":"config_base_url","value":"https://services.engagenest.com/config","type":"string"},{"key":"webengage_base_url","value":"https://services.engagenest.com/webengage","type":"string"},{"key":"moengage_base_url","value":"https://services.engagenest.com/moengage","type":"string"},{"key":"api_url","value":"https://api-01.engagenest.com","type":"string"},{"key":"tenantId","value":"<tenant id>","type":"string"},{"key":"bearerToken","value":"","type":"string"}]}