{"info":{"_postman_id":"1f3e57c7-2ef8-44cf-8b7a-00bb3e97b014","name":"Email Broadcast API Documentation","description":"

Description

\n

This documentation contains endpoints used to create and send broadcast campaigns, as well as several features including individual email or domain integration, subscriber data management, and downloading broadcast history log data.

\n

Base Url

\n

Base Url of email broadcast service. Fill the {{BaseUrl}} variable on env in postman or just write or replace the current base url to production or staging email broadcast service.

\n

Api Key

\n

Fill {{ApiKey}} variable on env in postman or just write or replace the current api key generated from auth login endpoint.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16008237","collectionId":"1f3e57c7-2ef8-44cf-8b7a-00bb3e97b014","publishedId":"2sA35A6QEt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-21T10:44:42.000Z"},"item":[{"name":"auth","item":[{"name":"Login User","id":"637bad65-3e8f-4541-8ed4-79da9fe46bd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"app_code\": \"\",\n \"authentication_token\": \"\",\n \"app_secret\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/auth/login","description":"

The API is used to generate the token that will be used for authentication in the email service.

\n","urlObject":{"path":["api","v1","auth","login"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9a8a6314-bdea-4097-b4c0-2166d6866250","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"app_code\": \"\",\n \"authentication_token\": \"\",\n \"app_secret\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"Authorization\",\r\n \"token\": \"eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\r\n}"}],"_postman_id":"637bad65-3e8f-4541-8ed4-79da9fe46bd5"},{"name":"Profile","id":"18759799-ced5-47a2-96cf-476532add40b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/auth/profile","description":"

Get user registered user profile data

\n","urlObject":{"path":["api","v1","auth","profile"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a719ba2a-7f47-4df3-88e3-c88d3d238f22","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/auth/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"Qiscus RnD\",\r\n \"created_at\": \"2024-01-30T03:42:33.749465+07:00\",\r\n \"admin\": true,\r\n \"app_id\": 1,\r\n \"email\": \"qiscus.rnd@gmail.com\",\r\n \"updated_at\": \"2024-01-30T03:42:33.749465+07:00\"\r\n}"}],"_postman_id":"18759799-ced5-47a2-96cf-476532add40b"}],"id":"3c8ac56a-8777-4f04-8062-d26906db449d","description":"

The following endpoint is used to generate a token that will be used for authentication across all API endpoints

\n","_postman_id":"3c8ac56a-8777-4f04-8062-d26906db449d"},{"name":"identities","item":[{"name":"Lists","id":"3d3b8997-f00f-4daf-811a-73ca6ac22a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/identities/lists?page=1&limit=10&identity=","description":"

List all integrated email data

\n","urlObject":{"path":["api","v1","identities","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, this field using for search by email address}

\n","type":"text/plain"},"key":"identity","value":""}],"variable":[]}},"response":[{"id":"661bb52f-a63e-4787-9325-5974b6f93e03","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/identities/lists?page=1&limit=10&identity=","host":["{{BaseUrl}}"],"path":["api","v1","identities","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"identity","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"is_enabled\": true,\r\n \"app_id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-02-05T05:29:42.096127+07:00\",\r\n \"email\": \"example2@gmail.com\",\r\n \"id\": 2,\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n },\r\n {\r\n \"is_enabled\": true,\r\n \"app_id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-03-13T06:28:16.965248+07:00\",\r\n \"email\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"3d3b8997-f00f-4daf-811a-73ca6ac22a00"},{"name":"Create","id":"9d11ad88-ebe4-4b13-ac84-f04c7c683902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/identities/create","description":"

Integrate single email

\n","urlObject":{"path":["api","v1","identities","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"236149b5-ee07-4a0f-b3d7-8075e742cc02","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/identities/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"is_enabled\": true,\r\n \"app_id\": 1,\r\n \"status\": \"pending\",\r\n \"updated_at\": \"2024-03-20T19:40:22.360289+07:00\",\r\n \"email\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-03-20T19:40:22.360289+07:00\"\r\n}"}],"_postman_id":"9d11ad88-ebe4-4b13-ac84-f04c7c683902"},{"name":"Create Using Domain","id":"615e9636-ebc4-4c49-919b-eff4ac39222c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/identities/domain/create","description":"

Integrate single email using registered domain

\n","urlObject":{"path":["api","v1","identities","domain","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2b79aef5-c5b3-4ca4-94ad-19da8acfc8e3","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/identities/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"is_enabled\": true,\r\n \"app_id\": 1,\r\n \"status\": \"pending\",\r\n \"updated_at\": \"2024-03-20T19:40:22.360289+07:00\",\r\n \"email\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-03-20T19:40:22.360289+07:00\"\r\n}"}],"_postman_id":"615e9636-ebc4-4c49-919b-eff4ac39222c"},{"name":"Update","id":"94e30293-4aca-4365-859a-5844eb4df84f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/identities/update/:id","description":"

Update integrated email data

\n","urlObject":{"path":["api","v1","identities","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9f8bdd74-2ae7-4fa1-8a3d-e8366f6e4139","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"status\": \"pending\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"localhost:8000/api/v1/identities/update/:id","host":["localhost"],"port":"8000","path":["api","v1","identities","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"is_enabled\": false,\r\n \"app_id\": 1,\r\n \"status\": \"pending\",\r\n \"updated_at\": \"2024-03-20T19:44:08+07:00\",\r\n \"email\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-03-20T19:40:22.360289+07:00\"\r\n}"}],"_postman_id":"94e30293-4aca-4365-859a-5844eb4df84f"},{"name":"Show","id":"4d3013f9-8451-4376-9ab3-0b5d32ba34e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/identities/show/:id","description":"

Get single integrated email data

\n","urlObject":{"path":["api","v1","identities","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d535f44c-0558-4155-8ce0-4f1b7fdc1726","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/identities/show/:id","host":["localhost"],"port":"8000","path":["api","v1","identities","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"is_enabled\": false,\r\n \"app_id\": 1,\r\n \"status\": \"pending\",\r\n \"updated_at\": \"2024-03-20T19:44:08+07:00\",\r\n \"email\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-03-20T19:40:22.360289+07:00\"\r\n}"}],"_postman_id":"4d3013f9-8451-4376-9ab3-0b5d32ba34e4"},{"name":"Delete","id":"68cbadf3-c4a6-4029-a33d-4265c229ba11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/identities/delete/:id","description":"

Delete integrated email data

\n","urlObject":{"path":["api","v1","identities","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0e0bd8ef-058a-4318-b76c-58171b7ccca5","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/identities/delete/:id","host":["localhost"],"port":"8000","path":["api","v1","identities","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"deleted\": true\r\n}"}],"_postman_id":"68cbadf3-c4a6-4029-a33d-4265c229ba11"},{"name":"Re Verify","id":"8e7d031f-692c-47ef-a3ab-71274ce6ad23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/identities/reverify-email/:id","description":"

Resend verification email when create identity not using registered domain

\n","urlObject":{"path":["api","v1","identities","reverify-email",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a9710714-aa43-42c3-ae87-ba70e7ccf974","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/identities/reverify-email/:id","host":["{{BaseUrl}}"],"path":["api","v1","identities","reverify-email",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"send_verification\": true\r\n}"}],"_postman_id":"8e7d031f-692c-47ef-a3ab-71274ce6ad23"}],"id":"89bea566-830f-4795-9b39-031e69f84e27","description":"

The following endpoint is used for managing emails to be integrated

\n","_postman_id":"89bea566-830f-4795-9b39-031e69f84e27"},{"name":"domains","item":[{"name":"Lists","id":"21422f0c-e83b-403e-a272-334b19d0a23b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/domains/lists?page=1&limit=10&domain=","description":"

List all integrated domain data

\n","urlObject":{"path":["api","v1","domains","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, this field using for search by domain address}

\n","type":"text/plain"},"key":"domain","value":""}],"variable":[]}},"response":[{"id":"20863870-4d71-463f-8f2a-9bfb996bc2d9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/domains/lists?page=1&limit=10&domain=","host":["{{BaseUrl}}"],"path":["api","v1","domains","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"domain","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"app_id\": 1,\r\n \"id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-03-18T06:30:00+07:00\",\r\n \"domain\": \"exmaple.com\",\r\n \"is_enabled\": true,\r\n \"extras\": {},\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"21422f0c-e83b-403e-a272-334b19d0a23b"},{"name":"Create","id":"a6aadeaa-39db-4554-8282-6bd291c3299a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"example.com\",\n \"status\": \"pending\",\n \"extras\": {},\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/domains/create","description":"

Integrate domain

\n","urlObject":{"path":["api","v1","domains","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"70565b66-f264-4b75-b9ee-ea1048051a06","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"examle.com\",\n \"status\": \"pending\",\n \"extras\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/domains/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-03-18T06:30:00+07:00\",\r\n \"domain\": \"example.com\",\r\n \"is_enabled\": true,\r\n \"extras\": {},\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n}"}],"_postman_id":"a6aadeaa-39db-4554-8282-6bd291c3299a"},{"name":"Update","id":"6ca6fac4-696f-4acf-ab95-3167a33dd171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"examle.com\",\n \"status\": \"pending\",\n \"extras\": \"\",\n \"is_enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/domains/update/:id","description":"

Update integrated domain data

\n","urlObject":{"path":["api","v1","domains","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6718f692-d1ae-454d-8028-c714fd6ca5b1","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"examle.com\",\n \"status\": \"pending\",\n \"extras\": {},\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"localhost:8000/api/v1/domains/update/:id","host":["localhost"],"port":"8000","path":["api","v1","domains","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-03-18T06:30:00+07:00\",\r\n \"domain\": \"example.com\",\r\n \"is_enabled\": true,\r\n \"extras\": {},\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n}"}],"_postman_id":"6ca6fac4-696f-4acf-ab95-3167a33dd171"},{"name":"Show","id":"8a45445b-3db7-468f-8813-6f243b99226b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/domains/show/:id","description":"

Show single integrated domain data

\n","urlObject":{"path":["api","v1","domains","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"36bfe970-6a2a-49b1-b957-d76a248a8354","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/domains/show/:id","host":["localhost"],"port":"8000","path":["api","v1","domains","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"id\": 1,\r\n \"status\": \"verified\",\r\n \"updated_at\": \"2024-03-18T06:30:00+07:00\",\r\n \"domain\": \"example.com\",\r\n \"is_enabled\": true,\r\n \"extras\": {},\r\n \"created_at\": \"2024-02-05T05:29:42.096127+07:00\"\r\n}"}],"_postman_id":"8a45445b-3db7-468f-8813-6f243b99226b"},{"name":"Delete","id":"7e346843-b227-4509-95da-b4b9456cca3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/domains/delete/:id","description":"

Delete integrated domain data

\n","urlObject":{"path":["api","v1","domains","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4fd29a08-5866-406d-ac4a-198f0d829afb","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/domains/delete/:id","host":["localhost"],"port":"8000","path":["api","v1","domains","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"deleted\": \"true\"}"}],"_postman_id":"7e346843-b227-4509-95da-b4b9456cca3e"}],"id":"40028134-a659-4581-bb15-7606f06d90d2","description":"

The following endpoint is used for managing domain email to be integrated

\n","_postman_id":"40028134-a659-4581-bb15-7606f06d90d2"},{"name":"subscribers","item":[{"name":"Lists","id":"8bd5762b-7ebf-417a-9040-d3b1c68a3de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscribers/lists?page=1&limit=10&group_id=0&tag_id=0&subscriber=","description":"

List all subcriber email data

\n","urlObject":{"path":["api","v1","subscribers","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, this field for filter by group-id}

\n","type":"text/plain"},"key":"group_id","value":"0"},{"description":{"content":"

{Optional, this field for filter by tag-id}

\n","type":"text/plain"},"key":"tag_id","value":"0"},{"description":{"content":"

{Optional, this field using for search by subcriber email address or name}

\n","type":"text/plain"},"key":"subscriber","value":""}],"variable":[]}},"response":[{"id":"806075a7-db0c-48ac-b98c-7caca7cc1b61","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/subscribers/lists?page=1&limit=10&group_id=0&tag_id=0&subscriber=","host":["{{BaseUrl}}"],"path":["api","v1","subscribers","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"group_id","value":"0"},{"key":"tag_id","value":"0"},{"key":"subscriber","value":"","description":"{Optional}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 2,\r\n \"name\": \"subscriber 2\",\r\n \"email\": \"subscriber2@example.com\",\r\n \"extras\": {},\r\n \"created_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"updated_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"app_id\": 1,\r\n \"groups_id\": [\r\n 1\r\n ],\r\n \"groups\": [\r\n \"group\"\r\n ],\r\n \"Tags_id\": [\r\n 1\r\n ],\r\n \"tags\": [\r\n \"tags\"\r\n ]\r\n },\r\n {\r\n \"id\": 1,\r\n \"name\": \"subscriber\",\r\n \"email\": \"subscriber@example.com\",\r\n \"extras\": {},\r\n \"created_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"updated_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"app_id\": 1,\r\n \"groups_id\": [],\r\n \"groups\": [],\r\n \"Tags_id\": [],\r\n \"tags\": []\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"8bd5762b-7ebf-417a-9040-d3b1c68a3de5"},{"name":"Create","id":"de4f53be-02f1-480b-bf0d-a224055127dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"extras\": {},\n \"groups\": [\n {\n \"id\": \"\",\n \"status\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/subscribers/create","description":"

Register subscription email

\n","urlObject":{"path":["api","v1","subscribers","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b418d368-7fa0-4526-8d5e-a59a1797da26","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"subscriber\",\n \"email\": \"subscriber@example.com\",\n \"extras\": {},\n \"groups\": [\n {\n \"id\": 1,\n \"status\": \"subscribe\"\n }\n ],\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8000/api/v1/subscribers/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"subscriber\",\r\n \"email\": \"subscriber@example.com\",\r\n \"extras\": {},\r\n \"created_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"updated_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"app_id\": 1,\r\n \"groups\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"sample-group\",\r\n \"status\": \"subscribe\"\r\n }\r\n ],\r\n \"tags\": []\r\n}"}],"_postman_id":"de4f53be-02f1-480b-bf0d-a224055127dc"},{"name":"Update","id":"b44c02bd-76ad-4203-854d-b22113a985ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"email\": \"\",\n \"extras\": {},\n \"groups\": [\n {\n \"id\": \"\",\n \"status\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/subscribers/update/:id","description":"

Update subscription email data

\n","urlObject":{"path":["api","v1","subscribers","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9a382ac7-5dba-44ad-8773-fc3d85803d14","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"update-subscriber\",\n \"email\": \"subscriber@example.com\",\n \"extras\": {},\n \"groups\": [\n {\n \"id\": 1,\n \"status\": \"subscribe\"\n }\n ],\n \"tags\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"localhost:8000/api/v1/subscribers/update/:id","host":["localhost"],"port":"8000","path":["api","v1","subscribers","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"update-subscriber\",\r\n \"email\": \"subscriber@example.com\",\r\n \"extras\": {},\r\n \"created_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"updated_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"app_id\": 1,\r\n \"groups\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"sample-group\",\r\n \"status\": \"subscribe\"\r\n }\r\n ],\r\n \"tags\": []\r\n}"}],"_postman_id":"b44c02bd-76ad-4203-854d-b22113a985ec"},{"name":"Show","id":"8732dde3-2cb6-4a18-8a89-35880f935e5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscribers/show/:id","description":"

Get subscription email data

\n","urlObject":{"path":["api","v1","subscribers","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fdef0a74-d0d1-4d83-873c-eca786be4f7b","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/subscribers/show/:id","host":["localhost"],"port":"8000","path":["api","v1","subscribers","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"subscriber\",\r\n \"email\": \"subscriber@example.com\",\r\n \"extras\": {},\r\n \"created_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"updated_at\": \"2024-03-18T07:16:34.567279+07:00\",\r\n \"app_id\": 1,\r\n \"groups\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"sample-group\",\r\n \"status\": \"subscribe\"\r\n }\r\n ],\r\n \"tags\": []\r\n}"}],"_postman_id":"8732dde3-2cb6-4a18-8a89-35880f935e5e"},{"name":"Delete","id":"e8a03b61-542c-4529-91a6-1985719f8a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscribers/delete/:id","description":"

Delete subscription email

\n","urlObject":{"path":["api","v1","subscribers","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d6b0b922-4a6c-42de-b915-fb451b7bf134","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:8000/api/v1/subscribers/delete/:id","host":["localhost"],"port":"8000","path":["api","v1","subscribers","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"deleted\": true\r\n}"}],"_postman_id":"e8a03b61-542c-4529-91a6-1985719f8a88"},{"name":"Export","id":"bd6fa1f1-2790-40b6-a88e-80eeaafe9484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscribers/export?file_format=","description":"

Export subscription email data to csv or xlsx

\n","urlObject":{"path":["api","v1","subscribers","export"],"host":["{{BaseUrl}}"],"query":[{"key":"file_format","value":""}],"variable":[]}},"response":[{"id":"49a8e67c-0d5a-4ff3-aedf-a88b95ce9175","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/subscribers/export?file_format=","host":["{{BaseUrl}}"],"path":["api","v1","subscribers","export"],"query":[{"key":"file_format","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"bd6fa1f1-2790-40b6-a88e-80eeaafe9484"},{"name":"Import Contact to Group","id":"76bd6f47-ce1a-4bd0-a692-3c8a545acd80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"

(Required)

\n","value":null}]},"url":"{{BaseUrl}}/api/v1/subscribers/import-to-group?group_id=0","description":"

Import contact to one group using excel file, The template file can be downloaded from the Broadcsat email service on Qiscus Omnichannel

\n","urlObject":{"path":["api","v1","subscribers","import-to-group"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"group_id","value":"0"}],"variable":[]}},"response":[{"id":"1f438063-d2b9-4273-a462-d8454d43ba28","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"file","value":"","type":"text"}]},"url":{"raw":"{{BaseUrl}}/api/v1/subscribers/import?group_id=","host":["{{BaseUrl}}"],"path":["api","v1","subscribers","import"],"query":[{"key":"group_id","value":"","description":"(rquired)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"contacts_stored \": \"true\"}"}],"_postman_id":"76bd6f47-ce1a-4bd0-a692-3c8a545acd80"},{"name":"Import Contact","id":"57fbee16-a5b5-466c-821c-31fbd19750c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"

(Required)

\n","value":null}]},"url":"{{BaseUrl}}/api/v1/subscribers/import","description":"

Import contact from excel file, The template file can be downloaded from the Broadcsat email service on Qiscus Omnichannel

\n","urlObject":{"path":["api","v1","subscribers","import"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"453331d8-b5c4-4edc-b954-57a23fcc1dd9","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"file","value":"","type":"text"}]},"url":{"raw":"{{BaseUrl}}/api/v1/subscribers/import?group_id=","host":["{{BaseUrl}}"],"path":["api","v1","subscribers","import"],"query":[{"key":"group_id","value":"","description":"(rquired)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"contacts_stored \": \"true\"}"}],"_postman_id":"57fbee16-a5b5-466c-821c-31fbd19750c1"}],"id":"6352e34a-650b-4bdb-a393-7af4686baa1b","description":"

The following endpoint is used for managing subscriber email data

\n","_postman_id":"6352e34a-650b-4bdb-a393-7af4686baa1b"},{"name":"subscriber-lists","item":[{"name":"Lists","id":"0f0442e7-f801-47c7-8920-93f8fb3f989d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscriber-lists/lists?page=1&limit=10&subscriber_list=","description":"

List all subcriber group data

\n","urlObject":{"path":["api","v1","subscriber-lists","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"subscriber_list","value":""}],"variable":[]}},"response":[{"id":"ca285f18-85c4-43ed-8264-93eed25d42d1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/subscriber-lists/lists?page=1&limit=10&subscriber_list=","host":["{{BaseUrl}}"],"path":["api","v1","subscriber-lists","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"subscriber_list","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"name\": \"testing bc\",\r\n \"id\": 6,\r\n \"created_at\": \"2024-03-06T03:16:10.896173+07:00\",\r\n \"updated_at\": \"2024-03-06T03:16:10.896173+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 2\r\n },\r\n {\r\n \"name\": \"group2\",\r\n \"id\": 5,\r\n \"created_at\": \"2024-03-01T02:23:31.350086+07:00\",\r\n \"updated_at\": \"2024-03-01T02:23:31.350086+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 0\r\n },\r\n {\r\n \"name\": \"group 3\",\r\n \"id\": 3,\r\n \"created_at\": \"2024-02-19T07:53:42.167677+07:00\",\r\n \"updated_at\": \"2024-02-19T07:53:42.167677+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 1\r\n },\r\n {\r\n \"name\": \"group 2\",\r\n \"id\": 2,\r\n \"created_at\": \"2024-02-19T07:53:34.360045+07:00\",\r\n \"updated_at\": \"2024-02-19T07:53:34.360045+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 3\r\n },\r\n {\r\n \"name\": \"group 1\",\r\n \"id\": 1,\r\n \"created_at\": \"2024-02-19T07:53:27.342614+07:00\",\r\n \"updated_at\": \"2024-02-19T07:53:27.342614+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 4\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"0f0442e7-f801-47c7-8920-93f8fb3f989d"},{"name":"Create","id":"79fd71e4-89c9-4887-9867-a98920bdb8f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/subscriber-lists/create","description":"

Create subcriber group

\n","urlObject":{"path":["api","v1","subscriber-lists","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"59d98c2f-a0fc-4899-9f64-4d9db65a5b48","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"subscriber-group\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}//api/v1/subscriber-lists/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"updated_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"subscriber-group\",\r\n \"created_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"id\": 7\r\n}"}],"_postman_id":"79fd71e4-89c9-4887-9867-a98920bdb8f0"},{"name":"Update","id":"026b4044-2894-423f-bab3-482aa57bd2cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/subscriber-lists/update/:id","description":"

Update subscriber group name

\n","urlObject":{"path":["api","v1","subscriber-lists","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"faf33ed9-dd50-499f-b444-9e3ef25bfe87","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"subscriber-group-update\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BaseUrl}}/api/v1/subscriber-lists/update/:id","host":["{{BaseUrl}}"],"path":["api","v1","subscriber-lists","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"updated_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"subscriber-group-update\",\r\n \"created_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"id\": 7\r\n}"}],"_postman_id":"026b4044-2894-423f-bab3-482aa57bd2cf"},{"name":"Show","id":"9b3d8b81-2406-421c-9fd0-e7e4ad1fbcd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscriber-lists/show/:id","description":"

Get single subscriber group data

\n","urlObject":{"path":["api","v1","subscriber-lists","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2e8fc79e-e463-4c59-be27-f30409bb5397","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/subscriber-lists/show/:id","host":["{{BaseUrl}}"],"path":["api","v1","subscriber-lists","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"name\": \"subscriber-group\",\r\n \"id\": 7,\r\n \"created_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"updated_at\": \"2024-03-20T21:00:09.084933+07:00\",\r\n \"app_id\": 1,\r\n \"total\": 0\r\n}"}],"_postman_id":"9b3d8b81-2406-421c-9fd0-e7e4ad1fbcd7"},{"name":"Delete","id":"d7745f62-f1c4-4753-867f-9daab2b29aec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscriber-lists/delete/:id","description":"

Delete subcriber group data

\n","urlObject":{"path":["api","v1","subscriber-lists","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d6da0535-f3aa-4f6f-96fa-6f99b3528a15","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"//api/v1/subscriber-lists/delete/:id","path":["","api","v1","subscriber-lists","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"deleted\": true\r\n}"}],"_postman_id":"d7745f62-f1c4-4753-867f-9daab2b29aec"},{"name":"Export","id":"2e3eb95d-2c39-4cdb-bb27-c4f5fe0f3c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/subscriber-lists/export?file_format=","description":"

Export subcriber group to csv or xlsx

\n","urlObject":{"path":["api","v1","subscriber-lists","export"],"host":["{{BaseUrl}}"],"query":[{"key":"file_format","value":""}],"variable":[]}},"response":[{"id":"c60eab61-68a4-4aa6-a51b-f0e20a129e16","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"//api/v1/subscriber-lists/export?file_format=","host":["/"],"path":["api","v1","subscriber-lists","export"],"query":[{"key":"file_format","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"2e3eb95d-2c39-4cdb-bb27-c4f5fe0f3c2f"}],"id":"64c39c01-5803-45e4-9676-0374e82160db","description":"

The following endpoint is used for managing subscriber group data

\n","_postman_id":"64c39c01-5803-45e4-9676-0374e82160db"},{"name":"tags","item":[{"name":"Lists","id":"18c9a1e1-1d98-472c-a734-4e2e3b7943c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/tags/lists","description":"

List all subcriber tags

\n","urlObject":{"path":["api","v1","tags","lists"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d6f6c68e-3817-4fa5-aa5c-61fc5a0f5cf7","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/tags/lists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"created_at\": \"2024-03-15T06:49:50.555639+07:00\",\r\n \"id\": 5,\r\n \"updated_at\": \"2024-03-15T06:49:50.555639+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"tags\"\r\n },\r\n {\r\n \"created_at\": \"2024-03-01T02:23:31.449489+07:00\",\r\n \"id\": 4,\r\n \"updated_at\": \"2024-03-01T02:23:31.449489+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"string1\"\r\n },\r\n {\r\n \"created_at\": \"2024-03-01T02:23:31.282820+07:00\",\r\n \"id\": 3,\r\n \"updated_at\": \"2024-03-01T02:23:31.282820+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"string\"\r\n }\r\n]"}],"_postman_id":"18c9a1e1-1d98-472c-a734-4e2e3b7943c7"},{"name":"Create","id":"ab15806a-be18-4ea3-8805-766ca74fae64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/tags/create","description":"

Create subcriber tag

\n","urlObject":{"path":["api","v1","tags","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"fce21bb7-1a5d-41ad-b15a-3e411e923f04","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/tags/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"created_at\": \"2024-03-20T21:10:57.045915+07:00\",\r\n \"id\": 6,\r\n \"updated_at\": \"2024-03-20T21:10:57.045915+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"string\"\r\n}"}],"_postman_id":"ab15806a-be18-4ea3-8805-766ca74fae64"},{"name":"Update","id":"cdce4777-9df7-4f05-822d-4794ee01a201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/tags/update/:id","description":"

Update subcriber tag name

\n","urlObject":{"path":["api","v1","tags","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"850e50b0-1486-43f7-bde2-447f77df8fa6","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"updated-string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BaseUrl}}/api/v1/tags/update/:id","host":["{{BaseUrl}}"],"path":["api","v1","tags","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"created_at\": \"2024-03-20T21:10:57.045915+07:00\",\r\n \"id\": 6,\r\n \"updated_at\": \"2024-03-20T21:12:08+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"updated-string\"\r\n}"}],"_postman_id":"cdce4777-9df7-4f05-822d-4794ee01a201"},{"name":"Show","id":"b859af98-f21c-49b5-9c18-8e162bdd8afd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/tags/show/:id","description":"

Get single subcriber tag data

\n","urlObject":{"path":["api","v1","tags","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5f65ee9a-b4a4-4bad-8971-5d1213e46af5","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/tags/show/:id","host":["{{BaseUrl}}"],"path":["api","v1","tags","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"created_at\": \"2024-03-20T21:10:57.045915+07:00\",\r\n \"id\": 6,\r\n \"updated_at\": \"2024-03-20T21:12:08+07:00\",\r\n \"app_id\": 1,\r\n \"name\": \"updated-string\"\r\n}"}],"_postman_id":"b859af98-f21c-49b5-9c18-8e162bdd8afd"},{"name":"Delete","id":"33be59a1-26fa-4ce7-8d3b-85a36c10c272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/tags/delete/:id","description":"

Delete subcriber tag data

\n","urlObject":{"path":["api","v1","tags","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7260db37-bcf2-4415-b5e4-11783af45ef5","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/tags/delete/:id","host":["{{BaseUrl}}"],"path":["api","v1","tags","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"deleted\": true\r\n}"}],"_postman_id":"33be59a1-26fa-4ce7-8d3b-85a36c10c272"}],"id":"f3029f54-5d5a-4940-96d0-2823411ec79e","description":"

The following endpoint is used for managing subsriber tag data

\n","_postman_id":"f3029f54-5d5a-4940-96d0-2823411ec79e"},{"name":"templates","item":[{"name":"Lists","id":"3090222a-aa74-4376-b97d-c8ef2d1aba36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/templates/lists?page=1&limit=10&template=&hide_template=true","description":"

List all created email template data

\n","urlObject":{"path":["api","v1","templates","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, his field using for search by template name}

\n","type":"text/plain"},"key":"template","value":""},{"key":"hide_template","value":"true"}],"variable":[]}},"response":[{"id":"7505b717-0f8b-4f4d-95be-74ae618a7313","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/templates/lists?page=1&limit=10&template=&hide_template=true","host":["{{BaseUrl}}"],"path":["api","v1","templates","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"template","value":""},{"key":"hide_template","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"app_id\": 1,\r\n \"subject\": \"template 2\",\r\n \"created_at\": \"2024-03-18T06:22:20.693283+07:00\",\r\n \"id\": 2,\r\n \"attachments\": {},\r\n \"name\": \"template 2\",\r\n \"updated_at\": \"2024-03-18T06:22:20.693283+07:00\"\r\n },\r\n {\r\n \"app_id\": 1,\r\n \"subject\": \"greeting {{name}}\",\r\n \"created_at\": \"2024-02-02T06:54:04.914647+07:00\",\r\n \"id\": 1,\r\n \"attachments\": {\r\n \"files\": []\r\n },\r\n \"name\": \"greeting\",\r\n \"updated_at\": \"2024-02-04T18:51:47+07:00\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"3090222a-aa74-4376-b97d-c8ef2d1aba36"},{"name":"Create","id":"46065fb2-db61-4916-84ae-10f4b865eda4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"template\": \"\",\n \"subject\": \"\",\n \"attachments\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/templates/create","description":"

Create single email templeate, template value using html format

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
paramsDescription
templatetemplate contains a html format. if you want to add parameters to the template, add them in the format {{key}}.
subjectThe subject contains a free-form string. if you want to add parameters to the subject, add them in the format {{key}}.
\n
","urlObject":{"path":["api","v1","templates","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9e42d862-b84b-47a3-98be-9feb8c809689","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"greeting 2\",\n \"template\": \"
Halo guys {{name}}
ini adalah testing email

{{email}}
\",\n \"subject\": null,\n \"attachments\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/templates/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"template\": \"
Halo guys {{name}}
ini adalah testing email

{{email}}
\",\r\n \"subject\": null,\r\n \"created_at\": \"2024-02-02T06:54:04.914647+07:00\",\r\n \"id\": 2,\r\n \"attachments\": {},\r\n \"name\": \"greeting 2\",\r\n \"updated_at\": \"2024-02-02T06:54:04.914647+07:00\"\r\n}"}],"_postman_id":"46065fb2-db61-4916-84ae-10f4b865eda4"},{"name":"Update","id":"0b141df5-794c-4250-b5ca-4f22ef72d568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"template\": \"\",\n \"subject\": \"\",\n \"attachments\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/templates/update/:id","description":"

Update created email template data, template value using html format

\n","urlObject":{"path":["api","v1","templates","update",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9982a970-9158-4abb-a166-909909c331ef","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"update greeting 2\",\n \"template\": \"
Halo guys {{name}}
ini adalah testing email

{{email}}
\",\n \"subject\": null,\n \"attachments\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BaseUrl}}/api/v1/templates/update/:id","host":["{{BaseUrl}}"],"path":["api","v1","templates","update",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"template\": \"
Halo guys {{name}}
ini adalah testing email

{{email}}
\",\r\n \"subject\": null,\r\n \"created_at\": \"2024-02-02T06:54:04.914647+07:00\",\r\n \"id\": 2,\r\n \"attachments\": {},\r\n \"name\": \"update greeting 2\",\r\n \"updated_at\": \"2024-02-02T06:54:04.914647+07:00\"\r\n}"}],"_postman_id":"0b141df5-794c-4250-b5ca-4f22ef72d568"},{"name":"Show","id":"a8d1d0be-fe5d-407e-bdf8-234a7c34e0bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/templates/show/:id","description":"

Ger single email template data

\n","urlObject":{"path":["api","v1","templates","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dc753dff-b734-4a76-aa0d-ab28e9d4f7a6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/templates/show/:id","host":["{{BaseUrl}}"],"path":["api","v1","templates","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"app_id\": 1,\r\n \"template\": \"
Halo guys {{name}}
ini adalah testing email

{{email}}
\",\r\n \"subject\": null,\r\n \"created_at\": \"2024-02-02T06:54:04.914647+07:00\",\r\n \"id\": 2,\r\n \"attachments\": {},\r\n \"name\": \"greeting 2\",\r\n \"updated_at\": \"2024-02-02T06:54:04.914647+07:00\"\r\n}"}],"_postman_id":"a8d1d0be-fe5d-407e-bdf8-234a7c34e0bb"},{"name":"Delete","id":"8d6f4433-7550-46e7-8439-2253cf922c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/templates/delete/:id","description":"

Delete single email template data

\n","urlObject":{"path":["api","v1","templates","delete",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2ba91703-1278-47f5-a10d-6347bc554e47","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/templates/delete/:id","host":["{{BaseUrl}}"],"path":["api","v1","templates","delete",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"deleted\": \"true\"\r\n}"}],"_postman_id":"8d6f4433-7550-46e7-8439-2253cf922c25"}],"id":"7da1878e-3e00-4714-9335-e5c754d24e49","description":"

The following endpoint is used for managing template data

\n","_postman_id":"7da1878e-3e00-4714-9335-e5c754d24e49"},{"name":"broadcast","item":[{"name":"histories","item":[{"name":"Show Histories","id":"f5d36352-8e97-4cae-8e01-9f3f6292e1b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/broadcast/histories/show/:id?page=1&limit=10&status=&recipient=","description":"

Show single history broadcast log data

\n","urlObject":{"path":["api","v1","broadcast","histories","show",":id"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, this field using for filter data by status}

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

{Optional, this field using for serach by recipient email }

\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ecbb3565-4113-4cae-bb9e-b51d5062678c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/broadcast/histories/show/:id?page=1&limit=10&status=&recipient=","host":["{{BaseUrl}}"],"path":["api","v1","broadcast","histories","show",":id"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"status","value":"","description":"{Optional}"},{"key":"recipient","value":"","description":"{Optional}"}],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"sender\": \"example@gmail.com\",\r\n \"id\": 2,\r\n \"message_id\": \"011cxxxxxxxxxxxxxxxxxxxxxxxxx\",\r\n \"open\": 1,\r\n \"delivery\": 0,\r\n \"bounce\": 0,\r\n \"complaint\": 0,\r\n \"click\": 0,\r\n \"updated_at\": \"2024-03-06T03:30:47.520736+07:00\",\r\n \"recipient\": \"example-subcriber2@gmail.com\",\r\n \"app_id\": 1,\r\n \"broadcast_id\": 2,\r\n \"status\": \"open\",\r\n \"send\": 1,\r\n \"fail\": 0,\r\n \"reject\": 0,\r\n \"created_at\": \"2024-03-06T03:30:47.520736+07:00\"\r\n },\r\n {\r\n \"sender\": \"example@gmail.com\",\r\n \"id\": 1,\r\n \"message_id\": \"011c01xxxxxxxxxxxxxxxxxxxxxxxx\",\r\n \"open\": 0,\r\n \"delivery\": 0,\r\n \"bounce\": 1,\r\n \"complaint\": 0,\r\n \"click\": 0,\r\n \"updated_at\": \"2024-03-06T03:30:47.958701+07:00\",\r\n \"recipient\": \"example-subcriber@gmail.com\",\r\n \"app_id\": 1,\r\n \"broadcast_id\": 2,\r\n \"status\": \"bounce\",\r\n \"send\": 1,\r\n \"fail\": 0,\r\n \"reject\": 0,\r\n \"created_at\": \"2024-03-06T03:30:47.958701+07:00\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"f5d36352-8e97-4cae-8e01-9f3f6292e1b1"},{"name":"Export Histories","id":"2530693d-3e78-48ed-91d2-cdfc71e7b999","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/broadcast/histories/export/:id?status=&file_format=","description":"

Export broadcast history log to excel or csv

\n","urlObject":{"path":["api","v1","broadcast","histories","export",":id"],"host":["{{BaseUrl}}"],"query":[{"description":{"content":"

{Optional, this field using for filter data by status}

\n","type":"text/plain"},"key":"status","value":""},{"key":"file_format","value":""}],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2530693d-3e78-48ed-91d2-cdfc71e7b999"}],"id":"c3263af9-95d3-43a0-b75c-aac0682469f0","description":"

The following endpoint is used for get broadcast history data

\n","_postman_id":"c3263af9-95d3-43a0-b75c-aac0682469f0"},{"name":"Lists","id":"f3956527-1c6f-4b4c-89e2-609b24136980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/broadcast/lists?page=1&limit=10&broadcast=","description":"

List all created broadcast data

\n","urlObject":{"path":["api","v1","broadcast","lists"],"host":["{{BaseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"description":{"content":"

{Optional, this field using for serach by broadcast name}

\n","type":"text/plain"},"key":"broadcast","value":""}],"variable":[]}},"response":[{"id":"06b1b8f6-7ee4-42e7-9386-5c780cf08cbf","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/broadcast/lists?page=1&limit=10&broadcast=","host":["{{BaseUrl}}"],"path":["api","v1","broadcast","lists"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"broadcast","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 2,\r\n \"name\": \"testing without params 21/03\",\r\n \"time\": \"2024-03-21T09:33:10.602222\",\r\n \"progres\": \"Sending\",\r\n \"scheduler_id\": null,\r\n \"template_id\": 2,\r\n \"template_name\": \"greeting 2\",\r\n \"created_at\": \"2024-03-21T09:33:10.602222+07:00\",\r\n \"updated_at\": \"2024-03-21T09:33:12.000000+07:00\"\r\n },\r\n {\r\n \"id\": 1,\r\n \"name\": \"testing with params 21/03\",\r\n \"time\": \"2024-03-21T09:32:36.514752\",\r\n \"progres\": \"finished\",\r\n \"scheduler_id\": null,\r\n \"template_id\": 2,\r\n \"template_name\": \"greeting 2\",\r\n \"created_at\": \"2024-03-21T09:32:36.514752+07:00\",\r\n \"updated_at\": \"2024-03-21T09:32:38.000000+07:00\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"total_page\": 1\r\n}"}],"_postman_id":"f3956527-1c6f-4b4c-89e2-609b24136980"},{"name":"Create","id":"f3af1867-fcc9-4478-90f3-18ac1ed75d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"time\": \"\",\n \"progress\": \"sending\",\n \"subject\": \"\",\n \"sender\": \"\",\n \"recipients\": [],\n \"template_id\": \"\",\n \"using_domain\": \"\",\n \"params\": {\"{{key}}\": \"{{value}}\"},\n \"group_id\": \"\",\n \"send_to_group\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/api/v1/broadcast/create","description":"

Create single scheduled broadcast.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
paramsdescription
using_domainPlease fill in with \"true\" if the sender originates from an email integrated through the domain, if using email integration fill wuth \"false\"
subjectThe subject contains a free-form string. if you want to add parameters to the subject, add them in the format {{key}}.
recipientsThe field serves to add email recipients. if you want send email to subcriber group, please fil it with []
paramsIt's useful for adding parameters with the model {\"{{key}}\": \"{{value}}\"}. The key will be used to call the value added to the subject or template. To add an email or customer name based on data from the subscriber, fill in the value with \"{{subscriber_email}}\" or \"{{subscriber_name}}\". Please note that the data must already be registered in the subscription. If not using parameters, simply fill in with {}.
send_to_groupThe field is set to \"true\" when you send to a subscriber group. Please remember that if you use send_to_group, the group_id must not be empty.
group_idIt contains the subscriber-group-d, if send_to_group is true.
\n
","urlObject":{"path":["api","v1","broadcast","create"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"68feb2da-e432-42d7-854e-0df0de271fa5","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"time\": \"\",\n \"progress\": \"sending\",\n \"subject\": \"\",\n \"sender\": \"\",\n \"recipients\": [],\n \"template_id\": \"\",\n \"using_domain\": \"\",\n \"params\": {\"{{key}}\": \"{{value}}\"},\n \"group_id\": \"\",\n \"send_to_group\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8000/api/v1/broadcast/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 2,\r\n \"name\": \"testing without params 21/03\",\r\n \"progres\": \"sending\",\r\n \"created_at\": \"2024-03-21T09:33:10.602222+07:00\",\r\n \"template_id\": 2,\r\n \"time\": \"2024-03-21T09:33:10.602222+07:00\",\r\n \"app_id\": 1,\r\n \"scheduler_id\": \"12xxxxxxxxxxxxxxxxxxxxxxxx\",\r\n \"updated_at\": \"2024-03-21T09:33:10.602222+07:00\"\r\n}"}],"_postman_id":"f3af1867-fcc9-4478-90f3-18ac1ed75d9a"},{"name":"Show","id":"d42dd7eb-3c38-43dc-943e-9be09967d251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{ApiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/broadcast/show/:id","description":"

Get single broadcast data

\n","urlObject":{"path":["api","v1","broadcast","show",":id"],"host":["{{BaseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f8da26fd-b38b-4db5-83e3-bfaaef3aa5a6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{BaseUrl}}/api/v1/broadcast/show/:id","host":["{{BaseUrl}}"],"path":["api","v1","broadcast","show",":id"],"variable":[{"key":"id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 2,\r\n \"name\": \"testing without params 21/03\",\r\n \"time\": \"2024-03-21T09:33:10.602222\",\r\n \"progres\": \"sending\",\r\n \"scheduler_id\": null,\r\n \"template_id\": 2,\r\n \"template_name\": \"greeting\",\r\n \"created_at\": \"2024-03-06T03:30:47.053008+07:00\",\r\n \"updated_at\": \"2024-03-06T03:30:47.053008+07:00\",\r\n \"total_opened\": 1,\r\n \"total_bounced\": 1,\r\n \"total_clicked\": 0,\r\n \"user\": \"Qiscus RnD\"\r\n}"}],"_postman_id":"d42dd7eb-3c38-43dc-943e-9be09967d251"}],"id":"bae72cb1-f08a-46d3-9077-2092ddb9d125","description":"

The following endpoint is used for managing broadcast data

\n","_postman_id":"bae72cb1-f08a-46d3-9077-2092ddb9d125"},{"name":"Healthcheck","id":"4f40fb2e-7cbe-4ada-87fc-e76ae333f039","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/healthcheck","urlObject":{"path":["api","v1","healthcheck"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2649cab6-9d75-4d4e-9bae-0ff169370a9c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{BaseUrl}}/api/v1/healthcheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"\",\n \"version\": \"\",\n \"description\": \"\"\n}"}],"_postman_id":"4f40fb2e-7cbe-4ada-87fc-e76ae333f039"}],"variable":[{"key":"baseUrl","value":"/","type":"string"}]}