The description for the CLOSUM V2.0 collection has been updated. Here's a summary of what was written:
\nIntro — A brief overview of the collection's purpose: a reference for the CLOSUM V2.0 REST API covering CRM, messaging, automation, and webhooks.
\nBase URL & Auth — Documents the base URL (https://api.closum.com/v2/) and the api-key query parameter requirement.
Modules — Requests are grouped into four logical sections:
\nCDP — Leads, Contacts, Tags, Contact Fields, Contact Tags, Lifecycle Stages, Sales Sequences, and Users
\nMessaging — SMS, SMS Balance, WhatsApp, Email Templates, Email Activity, and Company Numbers
\nUtilities — URL shortening
\nWebhooks — Payload references for Leads, SMS, Email, WhatsApp, and Unsubscribes events
\nGetting Started — A quick 3-step guide to set the API key and start making requests.
\nLet me know if you'd like to adjust the tone, add more detail to any section, or make any other changes.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3943255","collectionId":"74bd17c0-606c-46c8-9e92-c3842ff52aa3","publishedId":"Uz5CNduc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2d65dd"},"publishDate":"2022-05-30T14:09:57.000Z"},"item":[{"name":"Leads","item":[{"name":"Lead List","id":"4e697994-75c9-4545-9fee-13eccb5a7fb0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"host":true,"user-agent":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.closum.com/v2/lead/?api-key={{api_key}}&limit=&page=","description":"Available filters:
\nEmail: &email=hello@closum.com
Name: &name=Pedro Closum
Qualificação: &contact_lifecycle_stage_id=[]
Optional. Valid email or mobile
\n","type":"text/plain"},"key":"finder","value":""}],"variable":[]}},"response":[{"id":"27c003d1-c417-40b1-a27d-678dee7d319d","name":"Lead View","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/lead/view/{{lead_id}}?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","lead","view","{{lead_id}}"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"lead_data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"contact_lifecycle_stage_id\": 1,\n \"custom_data\": \"[]\",\n \"user_id\": 122,\n \"creation_date\": \"2025-02-13T10:21:55+00:00\",\n \"lead_opt_in\": {\n \"sms\": true,\n \"email\": true\n },\n \"phone\": {\n \"number\": \"000000000\"\n },\n \"email\": {\n \"email\": \"email@closum.com\"\n },\n \"contact_tag\": [],\n \"custom_fields\": [\n {\n \"field_id\": \"75daa806-0000-4bf6-0000-094c458a146f\",\n \"var\": \"company_name\",\n \"value\": \"Closum\"\n }\n ]\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-02-20T12:23:37+00:00\"\n}"},{"id":"19abf2c1-7eb4-4ac8-a8f4-cb4a4e3f7e84","name":"Lead View By Email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/lead/view/{{email}}?api-key={{api_key}}&finder=email","protocol":"https","host":["api","closum","com"],"path":["v2","lead","view","{{email}}"],"query":[{"key":"api-key","value":"{{api_key}}"},{"key":"finder","value":"email"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"lead_data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"contact_lifecycle_stage_id\": 1,\n \"custom_data\": \"[]\",\n \"user_id\": 122,\n \"creation_date\": \"2025-02-13T10:21:55+00:00\",\n \"lead_opt_in\": {\n \"sms\": true,\n \"email\": true\n },\n \"phone\": {\n \"number\": \"000000000\"\n },\n \"email\": {\n \"email\": \"email@closum.com\"\n },\n \"contact_tag\": [],\n \"custom_fields\": [\n {\n \"field_id\": \"75daa806-0000-4bf6-0000-094c458a146f\",\n \"var\": \"company_name\",\n \"value\": \"Closum\"\n }\n ]\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-02-20T12:23:37+00:00\"\n}"},{"id":"cf12b802-d162-4db2-95ea-94dae7e986ee","name":"Lead View By Mobile","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/lead/view/{{mobile}}?api-key={{api_key}}&finder=mobile","protocol":"https","host":["api","closum","com"],"path":["v2","lead","view","{{mobile}}"],"query":[{"key":"api-key","value":"{{api_key}}"},{"key":"finder","value":"mobile"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"lead_data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"contact_lifecycle_stage_id\": 1,\n \"custom_data\": \"[]\",\n \"user_id\": 122,\n \"creation_date\": \"2025-02-13T10:21:55+00:00\",\n \"lead_opt_in\": {\n \"sms\": true,\n \"email\": true\n },\n \"phone\": {\n \"number\": \"000000000\"\n },\n \"email\": {\n \"email\": \"email@closum.com\"\n },\n \"contact_tag\": [],\n \"custom_fields\": [\n {\n \"field_id\": \"75daa806-0000-4bf6-0000-094c458a146f\",\n \"var\": \"company_name\",\n \"value\": \"Closum\"\n }\n ]\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-02-20T12:23:37+00:00\"\n}"}],"_postman_id":"8f032a80-e101-4c52-b211-c029499cf22b"},{"name":"Lead Add","id":"ba501791-8cef-45ec-913c-de64ff6cc090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"name\": \"{name}\",\n\t\"email\": \"{email}\",\n\t\"mobile_number\": \"{mobile_number}\",\n\t\"consent_email\": \"{consent_email}\",\n\t\"consent_sms\": \"{consent_sms}\",\n\t\"contact_lifecycle_stage_id\": \"{contact_lifecycle_stage_id}\",\n\t\"custom_data\": \"{custom_data}\",\n\t\"tags\": [\"{tags}\"],\n\t\"birth_date\": \"{birth_date}\",\n\t\"custom_fields\": {\n\t\t\"var\": \"{value}\"\n\t},\n \"update_enabled\": \"{update_enabled}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/lead/add/?api-key={{api_key}}","description":"To send multiple tags, apply different keys inside tags[], ex: tags[1] tags[2] ... tags[...]
\n","urlObject":{"protocol":"https","path":["v2","lead","add",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"ba501791-8cef-45ec-913c-de64ff6cc090"},{"name":"Lead Add Note","id":"d2731a24-b0d9-47f0-90c1-583ee86f5d32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"note_message\": \"{note}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/lead/add-note/{{lead_id}}?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","lead","add-note","{{lead_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"d2731a24-b0d9-47f0-90c1-583ee86f5d32"},{"name":"Lead Notes List","id":"daa15bae-c3af-4d14-9746-cd5c69b8db94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/lead/notes/{{lead_id}}?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","lead","notes","{{lead_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"daa15bae-c3af-4d14-9746-cd5c69b8db94"},{"name":"Lead Edit","id":"e120277d-793e-4deb-b7c0-86def3da9ed6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\" : {{name}},\n \"mobile_number\" : {{mobile_number}},\n \"consent_email\" : {{consent_email}},\n \"consent_sms\" : {{consent_sms}},\n \"tags\": [{{tag1}}, {{tag2}}, {{...}}],\n \"birth_date\": {{birth_date}},\n \"contact_lifecycle_stage_id\": {{contact_lifecycle_stage_id}},\n \"sales_sequence_id\" : {{sales_sequence_id}},\n \"user_id\": {{user_id}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/lead/edit/{{lead_id}}?api-key={{api_key}}","description":"You are not allowed to change a lead email.
\nTo send multiple tags, apply different keys inside tags[], ex: tags[1] tags[2] ... tags[...]
\n","urlObject":{"protocol":"https","path":["v2","lead","edit","{{lead_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"e120277d-793e-4deb-b7c0-86def3da9ed6"},{"name":"Lead Edit By Email","id":"e48f9c11-8738-4825-bcfb-e84aa848c2f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\" : {{email}},\n \"name\" : {{name}},\n \"mobile_number\" : {{mobile_number}},\n \"consent_email\" : {{consent_email}},\n \"consent_sms\" : {{consent_sms}},\n \"tags\": [{{tag1}}, {{tag2}}, {{...}}],\n \"birth_date\": {{birth_date}},\n\t\"contact_lifecycle_stage_id\": {{contact_lifecycle_stage_id}},\n \"sales_sequence_id\" : {{sales_sequence_id}},\n \"user_id\": {{user_id}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/lead/edit-by-email?api-key={{api_key}}","description":"You are not allowed to change a lead email.
\nTo send multiple tags, apply different keys inside tags[], ex: tags[1] tags[2] ... tags[...]
\n","urlObject":{"protocol":"https","path":["v2","lead","edit-by-email"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"e48f9c11-8738-4825-bcfb-e84aa848c2f9"},{"name":"Lead Delete","id":"e48b189c-625b-4017-8a15-86fd63a07845","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.closum.com/v2/lead/delete/{{lead_id}}?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","lead","delete","{{lead_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"e48b189c-625b-4017-8a15-86fd63a07845"}],"id":"d9382283-5c69-468a-ad45-c1b3c567d07d","_postman_id":"d9382283-5c69-468a-ad45-c1b3c567d07d","description":""},{"name":"Contact","item":[{"name":"Contact List","id":"f1fc5513-3ead-422f-99ff-0d0484811a9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/contact/list?api-key={{api_key}}&limit=&page=","urlObject":{"protocol":"https","path":["v2","contact","list"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"},{"key":"limit","value":""},{"key":"page","value":""}],"variable":[]}},"response":[{"id":"f0c0fd74-9304-477d-88ca-51246e440ede","name":"List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/contact/list?api-key={{api_key}}&limit=&page=","protocol":"https","host":["api","closum","com"],"path":["v2","contact","list"],"query":[{"key":"api-key","value":"{{api_key}}"},{"key":"limit","value":""},{"key":"page","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Dec 2025 11:50:54 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=5VTPluJ9FN7uDqvA6W1lg84IuGOFM1UKQTWBGtUiwttfKwKHTzRv9mTVW25%2FmNs79xvv9U6%2BnTK%2B4CTo%2Fv1p2ybom%2B9Xu1zUExwQIlIF\"}]}"},{"key":"CF-RAY","value":"9aedf736582ca727-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"contacts\": [\n {\n \"id\": \"00000000-a0000-0000-a000-e000000000\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@closum.com\",\n \"mobile_number\": \"351910000000\",\n \"birth_date\": null,\n \"consent_email\": true,\n \"consent_sms\": true,\n \"email_status_id\": 1,\n \"creation_date\": \"2025-12-09T16:30:10+00:00\"\n }\n ],\n \"paginator\": {\n \"finder\": \"all\",\n \"page\": 1,\n \"current\": 1,\n \"count\": 150000,\n \"perPage\": 1,\n \"prevPage\": false,\n \"nextPage\": true,\n \"pageCount\": 150000,\n \"sort\": \"creation_date\",\n \"direction\": \"DESC\",\n \"limit\": 1,\n \"sortDefault\": \"creation_date\",\n \"directionDefault\": \"DESC\",\n \"scope\": null\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-12-16T11:50:54+00:00\"\n}"}],"_postman_id":"f1fc5513-3ead-422f-99ff-0d0484811a9c"},{"name":"Contact View","id":"1f51fc98-0703-4771-8ed5-bfa3cfcadfc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/contact/view/{{contact_id}}?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","contact","view","{{contact_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"},{"disabled":true,"key":"finder","value":"Optional. Valid email or mobile"}],"variable":[]}},"response":[{"id":"34419466-79bd-4c24-b3bc-02ca3db2a493","name":"View","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/contact/view/{{contact_id}}?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","contact","view","{{contact_id}}"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Dec 2025 12:02:00 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=tTsTcbplVbYXX2MyWzgE2s%2B116fksVLk4uVxi44sgw6H71x2DeBbuiEcF6mK5TJ3Qt54TV32C4OKBqMsz2WEj80Qi2lT4HacZnJzG1Tn\"}]}"},{"key":"CF-RAY","value":"9aee07829cd3c56e-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"contact_data\": {\n \"id\": \"00000000-a0000-0000-a000-e000000000\",\n \"name\": \"Pedro\",\n \"email\": \"pedro@closum.com\",\n \"mobile_number\": null,\n \"birth_date\": null,\n \"consent_email\": true,\n \"consent_sms\": true,\n \"email_status_id\": 1,\n \"creation_date\": \"2025-06-24T14:24:02+01:00\",\n \"contact_tag\": [\n {\n \"contact_id\": \"00000000-a0000-0000-a000-e000000000\",\n \"tag\": {\n \"id\": 0,\n \"tag\": \"Tag 1\"\n }\n },\n {\n \"contact_id\": \"00000000-a0000-0000-a000-e000000000\",\n \"tag\": {\n \"id\": 0,\n \"tag\": \"Tag 2\"\n }\n }\n ]\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-12-16T12:02:00+00:00\"\n}"}],"_postman_id":"1f51fc98-0703-4771-8ed5-bfa3cfcadfc4"},{"name":"Contact Add","id":"8312604d-05a5-429f-9faf-7c887f61d212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"{name}\",\n \"email\": \"{email}\",\n \"mobile_number\": \"{mobile_number}\",\n \"consent_email\": 1,\n \"consent_sms\": 1,\n \"tags\": [\"tag_name\"],\n \"birth_date\": \"{birth_date}\",\n \"custom_fields\": {\n \"{field_var}\": \"{value}\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/contact/add?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","contact","add"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"aeb31589-f393-47b0-b9a5-70d79346cba8","name":"Contact Add","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"{name}\",\n \"email\": \"{email}\",\n \"mobile_number\": \"{mobile_number}\",\n \"consent_email\": 1,\n \"consent_sms\": 1,\n \"tags\": [\"tag_name\"],\n \"birth_date\": \"{birth_date}\",\n \"custom_fields\": {\n \"{field_var}\": \"{value}\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.closum.com/v2/contact/add?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","contact","add"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [\n {\n \"contact_id\": \"00000000-a0000-0000-a000-e000000000\"\n }\n ],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-12-16T15:14:26+00:00\"\n}"}],"_postman_id":"8312604d-05a5-429f-9faf-7c887f61d212"},{"name":"Contact Update","id":"c8c4d404-3e25-4267-b7a5-2055098157c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"{name}\",\n \"email\": \"{email}\",\n \"mobile_number\": \"{mobile_number}\",\n \"consent_email\": 1,\n \"consent_sms\": 1,\n \"tags\": [\"tag_name\"],\n \"birth_date\": \"{birth_date}\",\n \"custom_fields\": {\n \"{field_var}\": \"{value}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/contact/edit/{{contact_id}}?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","contact","edit","{{contact_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"21c7be9b-daeb-46e2-b5c1-aab20d989f4d","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"name\": \"{{name}}\",\n\t\"email\": \"{{email}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.closum.com/v2/contact/edit/{{contact_id}}?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","contact","edit","{{contact_id}}"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Dec 2025 15:14:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=I5gF1QRvM6KfAoBNzo8UCaMAAF1tHBt7Xk9tuUbFIvTCFP7GVm%2FU2PsuM7EPGdck2K8R90e6I%2BIOTgQ6CsDUhVdfu60Nw2VO8Uq0%2FZTt\"}]}"},{"key":"CF-RAY","value":"9aef215f5b0881e1-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [\n {\n \"contact_id\": \"00000000-a0000-0000-a000-e000000000\"\n }\n ],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-12-16T15:14:26+00:00\"\n}"}],"_postman_id":"c8c4d404-3e25-4267-b7a5-2055098157c3"},{"name":"Contact Delete","id":"265d9810-b2f3-4344-b49b-5c967394bd6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.closum.com/v2/contact/delete/{{contact_id}}?api-key={{api_key}}","description":"This endpoint deletes Contact by provideded ID and the Lead associated Data.
\n","urlObject":{"protocol":"https","path":["v2","contact","delete","{{contact_id}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"265d9810-b2f3-4344-b49b-5c967394bd6a"}],"id":"cbb71077-e6b8-4318-9d60-561a37767100","_postman_id":"cbb71077-e6b8-4318-9d60-561a37767100","description":""},{"name":"Tag","item":[{"name":"Load Tag","id":"60770534-f357-4180-a6b2-9a93c609866f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/tag/?api-key={{api_key}}&limit=&page=","urlObject":{"protocol":"https","path":["v2","tag",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"},{"key":"limit","value":""},{"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"60770534-f357-4180-a6b2-9a93c609866f"},{"name":"Add Tag","id":"db08221b-f9f4-4305-a28a-1015223a466a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tag\": \"tag_exemplo\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/tag/add/?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","tag","add",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"db08221b-f9f4-4305-a28a-1015223a466a"},{"name":"Delete Tag","id":"7f385a11-122f-40bb-9b47-0ccf10c4ba2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.closum.com/v2/tag/delete/{{tag_id_or_tag_name}}?api-key={{api_key}}","description":"This endpoint permanently deletes a Tag from your entire account and its associations with contacts, leads, and audiences.
\n","urlObject":{"protocol":"https","path":["v2","tag","delete","{{tag_id_or_tag_name}}"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"367e3e82-7623-4c46-ada2-b3f07d56b08d","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.closum.com/v2/tag/delete/{{tag_id_or_tag_name}}?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","tag","delete","{{tag_id_or_tag_name}}"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-10-27T11:50:28+00:00\"\n}"}],"_postman_id":"7f385a11-122f-40bb-9b47-0ccf10c4ba2a"}],"id":"5a57f0d2-9df4-4c09-ac8b-b7815b996d04","_postman_id":"5a57f0d2-9df4-4c09-ac8b-b7815b996d04","description":""},{"name":"Contact Fields","item":[{"name":"Load Contact Fields","event":[{"listen":"test","script":{"id":"2de92567-6d3d-49c5-b334-83123901bdf1","exec":["var template = `","","","| Field ID | ","Field Name | ","Type | ","Required | ","
|---|---|---|---|
| {{id}} | ","{{name}} | ","{{type}} | ","{{required}} | ","
This API endpoint makes an HTTP GET request to retrieve field information. The request requires an api-key parameter in the URL.
Method: GET
URL: https://api.closum.com/v2/field/?api-key={{api_key}}
Available filters:
\nTag: &tag=b2b-customers
Set to 1 to enable UTM parameters
Override the default from_email in the email template
Use this endpoint to send designed email templates with custom vars.
Apply {{var_key}} inside the email design, and prefill it with our api call.
Replace for example {{company_name}} with \"merge[company_name]\" : \"Closum\".
It is also possible to send one or more items in the merge field.
Each item can contain up to 5 fields. For example: \"items\":[{\"field1\":\"Name\",\"field2\":\"Price\"}]
Available filters:
\nPage: &page=1
Limit: &limit=10
By default, each page returns 20 results, but it is possible to change this with &limit
\n","urlObject":{"protocol":"https","path":["v2","email-template","list",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"a0dea18e-7526-4ec2-b805-534b4002acc9","name":"Load Email Template","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/email-template/list/?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","email-template","list",""],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"email_template\": [\n {\n \"id\": 1,\n \"title\": \"Test1\",\n \"image_template\": \"https://example.com/images/1.png\"\n },\n {\n \"id\": 2,\n \"title\": \"Test2\",\n \"image_template\": \"https://example.com/images/2.png\"\n },\n {\n \"id\": 3,\n \"title\": \"Test3\",\n \"image_template\": \"https://example.com/images/3.png\"\n }\n ]\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-09-11T14:07:17+01:00\"\n}"}],"_postman_id":"7cef4821-90f3-46a9-8e22-9c6d036d3cba"},{"name":"Create Email Template","id":"5df1dd20-9d22-4154-9c63-023e6e581142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from_name","value":"{{from_name}}","description":"Sender name
\n","type":"text","uuid":"9348a316-3af9-4437-9863-8b73674308df"},{"key":"from_email","value":"{{from_email}}","description":"Sender email address
\n","type":"text","uuid":"cf50f208-c5a5-4dd5-a34e-21ab322b7b9d"},{"key":"template_title","value":"{{template_title}}","description":"The title of the new Template
\n","type":"text","uuid":"f09cdd10-e907-45b3-9279-4288e950f893"},{"key":"html_content","value":"{{html_content}}","description":"The HTML content of the Template. Max length: 1048576
You can add a new email template by sending data, including the HTML content itself, to the /create endpoint. When building templates from scratch, keep in mind the styling limitations that apply across different email clients.
Since the /create endpoint simplifies the process, you can design templates with your own tools or import existing layouts you already use.
Template Id to update
\n","type":"text","uuid":"0780d26c-5fc2-4c74-a2f3-340ad4a8e0e7"},{"key":"from_name","value":"{{from_name}}","description":"Sender name
\n","type":"text","uuid":"9348a316-3af9-4437-9863-8b73674308df"},{"key":"from_email","value":"{{from_email}}","description":"Sender email address
\n","type":"text","uuid":"cf50f208-c5a5-4dd5-a34e-21ab322b7b9d"},{"key":"template_title","value":"{{template_title}}","description":"The title of the Template
\n","type":"text","uuid":"f09cdd10-e907-45b3-9279-4288e950f893"},{"key":"html_content","value":"{{html_content}}","description":"The updated HTML content. Max length: 1048576
You can update an existing email template by sending the modified data, including the updated HTML content, to the /update endpoint. When editing templates, remember that styling limitations still apply across different email clients.
Available filters:
\n","urlObject":{"protocol":"https","path":["v2","email-activity","logs",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"eb51f3ce-c8b3-48f6-bc43-3ed92dd8b0bf","name":"Load Logs","originalRequest":{"method":"GET","header":[],"body":{"mode":"graphql","graphql":{"query":"","variables":""}},"url":{"raw":"https://api.closum.com/v2/email-activity/logs/?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","email-activity","logs",""],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"logs\": [\n {\n \"id\": 000001,\n \"subject\": \"Email Subject\",\n \"to\": \"email@closum.com\",\n \"from\": \"closum@closum.com\",\n \"event\": \"opened\",\n \"reason\": \"Unknown\",\n \"activity_date\": \"2025-07-31T17:14:40+01:00\"\n },\n {\n \"id\": 000002,\n \"subject\": \"Email Subject\",\n \"to\": \"email2@closum.com\",\n \"from\": \"closum@closum.com\",\n \"event\": \"sent\",\n \"reason\": \"Unknown\",\n \"channel\": \"Newsletters\",\n \"activity_date\": \"2025-07-31T16:58:53+01:00\"\n }\n ],\n \"paginator\": {\n \"finder\": \"all\",\n \"page\": 1,\n \"current\": 2,\n \"count\": 71,\n \"perPage\": 2,\n \"prevPage\": false,\n \"nextPage\": true,\n \"pageCount\": 36,\n \"sort\": null,\n \"direction\": false,\n \"limit\": 2,\n \"sortDefault\": false,\n \"directionDefault\": false,\n \"scope\": null\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-09-18T18:09:50+01:00\"\n}"}],"_postman_id":"348b1a67-fcf5-479c-8808-d983a3f664ce"}],"id":"b7fb4b3d-d291-448c-9673-3068ba766c94","_postman_id":"b7fb4b3d-d291-448c-9673-3068ba766c94","description":""},{"name":"SMS","item":[{"name":"Send Single SMS","event":[{"listen":"test","script":{"id":"379399a8-82f7-4da1-a768-e64b790fd7f5","exec":["{"," \"status\": false,"," \"code\": 200,"," \"responseData\": [],"," \"message\": [],"," \"errors\": ["," \"Invalid API Key\""," ],"," \"timestamp\": \"2024-12-17T16:16:38+00:00\"","}"],"type":"text/javascript","packages":{}}}],"id":"94f1d7d2-9974-4d6b-91ae-422b53eba30f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"message\": \"{message_string}\",\n \"recipient\": \"{recipient}\",\n \"sender\": \"{11char_sender}\",\n \"send_time\": 1701622186\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/sms/send/?api-key={{api_key}}","description":"","urlObject":{"protocol":"https","path":["v2","sms","send",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"bc10ce75-194d-44d8-ace2-fa2119a6ae81","name":"Success 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"message\": \"{message_string}\",\n \"recipient\": \"{recipient}\",\n \"sender\": \"{11char_sender}\",\n \"send_time\": 1701622185\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.closum.com/v2/sms/send/?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","sms","send",""],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [],\n \"message\": {\n \"status\": \"success\",\n \"credits_used\": 1,\n \"scheduled\": \"2024-12-17T16:04:32+00:00\",\n \"msgid\": \"8c4c03fd-b985-4892-8561-a7d4ff4eb243\"\n },\n \"errors\": [],\n \"timestamp\": \"2024-12-17T16:04:32+00:00\"\n}"}],"_postman_id":"94f1d7d2-9974-4d6b-91ae-422b53eba30f"}],"id":"83a245fe-5af5-4ad0-885d-66a787a251ca","_postman_id":"83a245fe-5af5-4ad0-885d-66a787a251ca","description":""},{"name":"SMS Balance","item":[{"name":"Load Available SMS Credits","id":"0b61cbc7-604e-4e27-9eef-2439a084bc31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/sms-balance/available-credits/?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","sms-balance","available-credits",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"0b61cbc7-604e-4e27-9eef-2439a084bc31"}],"id":"d136f8e2-44c0-4869-a01d-e1dfd0baaec1","_postman_id":"d136f8e2-44c0-4869-a01d-e1dfd0baaec1","description":""},{"name":"Contact Lifecycle Stage","item":[{"name":"Load Contact Lifecycle Stage","id":"bd1351c1-926b-4e22-b7af-92742a2cb540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/contact-lifecycle-stage/?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","contact-lifecycle-stage",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"bd1351c1-926b-4e22-b7af-92742a2cb540"}],"id":"b190b111-8674-4ed5-b991-7df5bb8e5316","_postman_id":"b190b111-8674-4ed5-b991-7df5bb8e5316","description":""},{"name":"Utils","item":[{"name":"Shorten Url","id":"8c4d9aec-b041-44c5-b74b-ed0633d2d224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"{url}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/utils/shorten-url/?api-key={{api_key}}","description":"","urlObject":{"protocol":"https","path":["v2","utils","shorten-url",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"8c4d9aec-b041-44c5-b74b-ed0633d2d224"}],"id":"9b521e9f-1206-4643-ae76-4c98e73834dc","_postman_id":"9b521e9f-1206-4643-ae76-4c98e73834dc","description":""},{"name":"User","item":[{"name":"Load Users","id":"3818e36a-7f1d-4db9-bcc3-538bfe42daf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/user/?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","user",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"3818e36a-7f1d-4db9-bcc3-538bfe42daf1"}],"id":"d3555544-df1f-40c0-9702-6f19b4291522","_postman_id":"d3555544-df1f-40c0-9702-6f19b4291522","description":""},{"name":"Sales Sequence","item":[{"name":"Load Sales Sequence","id":"bed8d182-820f-40b1-9fb8-6f9e6888c821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/sales-sequence/?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","sales-sequence",""],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"bed8d182-820f-40b1-9fb8-6f9e6888c821"}],"id":"0971be65-c546-42b8-ba67-807d7d0bdd63","_postman_id":"0971be65-c546-42b8-ba67-807d7d0bdd63","description":""},{"name":"Whatsapp","item":[{"name":"Send Template","id":"87f6024d-54b7-41c7-9b34-bf6b35d6240e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"template_slug\": \"{template_slug}\",\n \"from\": \"{from}\",\n \"to\": \"{to}\",\n \"parameters\": {\n \"{{firstname}}\": \"Pedro\",\n \"{{company}}\": \"Closum\"\n }\n}\n\n","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/whatsapp/send?api-key={{api_key}}","description":"Use this endpoint to send designed whatsapp templates.
\n","urlObject":{"protocol":"https","path":["v2","whatsapp","send"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"87f6024d-54b7-41c7-9b34-bf6b35d6240e"},{"name":"Load Templates","id":"257cfd25-03d6-4479-a217-8db6455fb151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/whatsapp/get-templates?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","whatsapp","get-templates"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"af275aa7-3c05-458f-a2a5-6510c215f996","name":"Load Templates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/whatsapp/get-templates?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","whatsapp","get-templates"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"whatsappTemplate\": [\n {\n \"title\": \"Model Template 1\",\n \"slug\": \"1_model_1\",\n \"status\": \"APPROVED\",\n \"variables\": [\n \"{{firstname}}\",\n \"{{company_name}}\"\n ],\n \"creation_date\": \"2025-02-25T14:40:19+00:00\"\n },\n {\n \"title\": \"Model Template 2\",\n \"slug\": \"1_model_2\",\n \"status\": \"APPROVED\",\n \"creation_date\": \"2025-02-25T10:12:35+00:00\"\n }\n ]\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-02-26T11:55:57+00:00\"\n}"}],"_postman_id":"257cfd25-03d6-4479-a217-8db6455fb151"}],"id":"de04527e-4c7d-4c93-b231-80955a8664c9","_postman_id":"de04527e-4c7d-4c93-b231-80955a8664c9","description":""},{"name":"Company Number","item":[{"name":"Load Numbers","id":"52c622c4-ce6e-4461-9821-c23e7897f0de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/company-number/get-senders?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","company-number","get-senders"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"d17e49e0-5280-40f9-b721-c56940d65f47","name":"Load Numbers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/company-number/get-senders?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","company-number","get-senders"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"senders\": [\n {\n \"number\": \"351920000000\"\n }\n ]\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2025-02-26T11:58:43+00:00\"\n}"}],"_postman_id":"52c622c4-ce6e-4461-9821-c23e7897f0de"}],"id":"f2531539-b985-4a9d-9375-bae31814c89d","_postman_id":"f2531539-b985-4a9d-9375-bae31814c89d","description":""},{"name":"Topic","item":[{"name":"Topic List","id":"7d38f40e-0630-4c07-b05f-07ddb87a0261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/topic/list?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","topic","list"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"775642fc-ffdf-456b-972b-6574a64043cf","name":"Topic List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/topic/list?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","topic","list"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Fri, 27 Mar 2026 10:03:18 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=RNyZizJc6SCkkVHtq%2BwhpU7N2kjlN1NRQqIHm3Y%2FjhyE2Wxb4KYi8wCTobRKG1me%2BRM2nxH7DLl0%2FlqVJXJvrL%2BDxthdReOPVSr%2F7PsSIM2QUPYv4dOwdT6F7nCiW0myyQ%3D%3D\"}]}"},{"key":"CF-RAY","value":"9e2d907e885ed6c8-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"topics\": [\n {\n \"id\": 4,\n \"title\": \"Novidades\",\n \"description\": \"O que há de novo para você.\",\n \"creation_date\": \"2026-03-18T15:42:37+00:00\"\n },\n {\n \"id\": 5,\n \"title\": \"Alertas\",\n \"description\": \"Informações rápidas que merecem a sua atenção.\",\n \"creation_date\": \"2026-03-18T15:42:46+00:00\"\n },\n {\n \"id\": 6,\n \"title\": \"Avisos\",\n \"description\": \"Comunicados importantes de forma clara.\",\n \"creation_date\": \"2026-03-18T15:42:53+00:00\"\n }\n ]\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2026-03-27T10:03:18+00:00\"\n}"}],"_postman_id":"7d38f40e-0630-4c07-b05f-07ddb87a0261"},{"name":"Topic View","id":"45677a1d-350b-430f-8578-2e8f7a2d879d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.closum.com/v2/topic/view/4?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","topic","view","4"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"c1a1dd38-7252-4b3d-ab12-5c4cad1cea10","name":"Topic View","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.closum.com/v2/topic/view/4?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","topic","view","4"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 27 Mar 2026 10:07:30 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=pZmPbN%2B6xy%2F6oue5sZoaYj%2BuFUIIBQofJk%2FD%2BPaODzp75ZVcAwV0I3HQuhvQU7gbssg9qe%2BeC%2BReWf3Zoq%2BqJnEU%2FTsgtGhwlEAleeKPgZ48%2F4%2FBhkMmbzDHBNvCUmngcQ%3D%3D\"}]}"},{"key":"CF-RAY","value":"9e2d96a7bb3189b1-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": {\n \"topic\": {\n \"id\": 4,\n \"title\": \"Novidades\",\n \"description\": \"O que há de novo para você.\",\n \"creation_date\": \"2026-03-18T15:42:37+00:00\"\n }\n },\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2026-03-27T10:07:30+00:00\"\n}"}],"_postman_id":"45677a1d-350b-430f-8578-2e8f7a2d879d"},{"name":"Topic Add","id":"8798bf82-5abc-477c-9273-82aff137dd18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"New Topic\",\n \"description\": \"topic description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/topic/add?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","topic","add"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"485047ea-0c4a-4d73-b189-7e20b74d7964","name":"Topic Add","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"New Topic\",\n \"description\": \"topic description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.closum.com/v2/topic/add?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","topic","add"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 27 Mar 2026 10:09:06 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=6Jcyxu25Mt7WXrslGJrQTZc32sNXqA%2FMnqka4sRFEQKuXldyZ0PsBn3iY2eD%2Bj%2FX7ZXryIvVGJgjUpaiJEi8IqVkUHn1zCSTFJYbuS5u14G9KbwzMtPMALDd4OOGLP3HDA%3D%3D\"}]}"},{"key":"CF-RAY","value":"9e2d98faa8e0057a-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [\n {\n \"topic_id\": 7\n }\n ],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2026-03-27T10:09:05+00:00\"\n}"}],"_postman_id":"8798bf82-5abc-477c-9273-82aff137dd18"},{"name":"Topic Edit","id":"d971c9c8-3203-4c49-b7cb-d4f5d85e9da7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"update topic\",\n \"description\": \"topic description updated\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/topic/edit/7?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","topic","edit","7"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"0e582cdf-9adf-4941-a999-7b71a60c13b2","name":"Topic Edit","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"update topic\",\n \"description\": \"topic description updated\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.closum.com/v2/topic/edit/7?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","topic","edit","7"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 27 Mar 2026 10:13:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=q8q%2B7QGZH5NU9E8Cb2eaz03pruxfND%2BqiRaMGyfpVwa4R9sbsuuFhzfzn9Ykxuf9328aFu8adyfXa7YzPt5Iunqfh7lAumMLOcC%2Bi4fevHXA2A306Tafg%2FA92gTMVwNqCw%3D%3D\"}]}"},{"key":"CF-RAY","value":"9e2d9fe9693129be-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [\n {\n \"topic_id\": 7\n }\n ],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2026-03-27T10:13:49+00:00\"\n}"}],"_postman_id":"d971c9c8-3203-4c49-b7cb-d4f5d85e9da7"},{"name":"Topic Delete","id":"32475f2d-1ae7-4dbd-9236-44f7a3913961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.closum.com/v2/topic/delete/7?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","topic","delete","7"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"982c235f-3792-42e5-9545-c52f80c86d9b","name":"Topic Delete","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.closum.com/v2/topic/delete/7?api-key={{api_key}}","protocol":"https","host":["api","closum","com"],"path":["v2","topic","delete","7"],"query":[{"key":"api-key","value":"{{api_key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 27 Mar 2026 10:16:00 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Accept-Encoding"},{"key":"x-powered-by","value":"PHP/7.4.33"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type, x-xsrf-token"},{"key":"access-control-max-age","value":"172800"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=ALTf%2FVyYIT8tJ1o5SA9dgEJpCmAAJr3%2F%2FOBJWsE9Iivbam5oYoUwnpukXLFkmYUC%2FLI50dUw7DGW1B8c%2BNASoknG4qOi33oCIokpCkS3v3ezF0fCE9hRWtaq09fREbrHzQ%3D%3D\"}]}"},{"key":"CF-RAY","value":"9e2da31b6b47e611-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": true,\n \"code\": 200,\n \"responseData\": [],\n \"message\": [\n \"success\"\n ],\n \"errors\": [],\n \"timestamp\": \"2026-03-27T10:16:00+00:00\"\n}"}],"_postman_id":"32475f2d-1ae7-4dbd-9236-44f7a3913961"}],"id":"9d84ae02-af45-452b-a081-28daefc56a13","_postman_id":"9d84ae02-af45-452b-a081-28daefc56a13","description":""},{"name":"Webhooks","item":[{"name":"Contact","id":"54db1497-c46a-4467-aa21-524e4bb26403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://your-application.com?id=00000000-0000-0000-0000-000000000000&name=John&phone=&email=john@closum.com&consent_email=1&consent_sms=1&tags%5B0%5D=tag123&creation_date=2026-01-01","description":"With the “Contact” webhook, you can configure your application to receive information in real time whenever a Contact is updated.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\nWith the “Leads” webhook, you can configure your application to receive information in real time whenever a Lead is updated.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\nWith the “SMS” webhook, you can configure your application to receive information in real time about SMS status.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\ndelivered, accepted, expired, failed, rejected
\n","type":"text/plain"},"key":"status","value":"delivered"},{"key":"is_unicode","value":"1"}],"variable":[]}},"response":[],"_postman_id":"62b85e8d-f01f-44e0-ba90-d1dc057339ad"},{"name":"Email","id":"70a10132-e808-40a3-a532-4cc931a8259b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-application.com?campaign_id=0001&from=from@email.com&to=to@email.com&subject=Email Webhook in Closum&activity_label=sent&category=","description":"With the “Email” webhook, you can configure your application to receive information in real time about Email activity.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\nsent, opened, clicked, bounced, unsubscribed, abuse_report
\n","type":"text/plain"},"key":"activity_label","value":"sent"},{"description":{"content":"AccountProblem, BlackListed, CodeError, ConnectionProblem, ConnectionTerminated, DNSProblem, GreyListed, Ignore, NoMailbox, NotDelivered, Spam, SPFProblem, Throttled
\n","type":"text/plain"},"key":"category","value":""}],"variable":[]}},"response":[],"_postman_id":"70a10132-e808-40a3-a532-4cc931a8259b"},{"name":"Whatsapp","id":"3230efe9-e8dd-457c-9bd5-da01c5db38c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-application.com/?company_id=1&recipient=351912345678&sender=351910000000&channel=whatsapp&message_uuid=1111111-11111-11111-11111-111111111&status=delivered","description":"With the “Whatsapp” webhook, you can configure your application to receive information in real time about Whatsapp messages.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\nsubmitted, delivered, read, answer, rejected
\n","type":"text/plain"},"key":"status","value":"delivered"}],"variable":[]}},"response":[],"_postman_id":"3230efe9-e8dd-457c-9bd5-da01c5db38c2"},{"name":"Unsubscribes","id":"c52d247b-559d-488b-98be-fbf2a7c31cfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-application.com/?contact_id=contact_id&name=name&phone=910000000&email=email@closum.com&status_email=0&status_sms=1","description":"With the “Unsubscribes” webhook, you can configure your application to receive information in real time about unsubscribes.
\nCreate a URL in your application and prepare an HTTP endpoint to receive the notifications. This endpoint must be able to:
\nTo register your Webhook with Closum, log in to your Closum account at: Settings - Application - Integrations - Webhooks
\n0 - unsubscribed\n1 - subscribed
\n","type":"text/plain"},"key":"status_email","value":"0"},{"description":{"content":"0 - unsubscribed\n1 - subscribed
\n","type":"text/plain"},"key":"status_sms","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c52d247b-559d-488b-98be-fbf2a7c31cfe"}],"id":"c417b05e-6b81-48c9-81a7-574035f2b457","description":"Closum currently supports webhooks for “Leads”, “SMS”, \"Email\", \"Whatsapp\" and \"Unsubscribes\".
\n","_postman_id":"c417b05e-6b81-48c9-81a7-574035f2b457"},{"name":"Event Tracker","item":[{"name":"Track Page Views","id":"438a9cf6-1ae9-4984-a240-81f2456d8acf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"{email}\",\n \"track\": \"login\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/event-tracker/track?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","event-tracker","track"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"438a9cf6-1ae9-4984-a240-81f2456d8acf"},{"name":"Track Custom Events","id":"17ab1e99-e6df-4ada-b658-0d3fd24397a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"{email}\",\n \"track\": \"purchase\",\n \"properties\": {\n \"value\": \"{{total_value}}\",\n \"order_id\": \"{{order_id}}\",\n \"data\": {\n \"total\": \"{quantity_products_in_cart}\",\n \"items\": {\n \"name\": \"{product_name}\",\n \"quantity\": \"{product_quantity\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.closum.com/v2/event-tracker/track?api-key={{api_key}}","urlObject":{"protocol":"https","path":["v2","event-tracker","track"],"host":["api","closum","com"],"query":[{"key":"api-key","value":"{{api_key}}"}],"variable":[]}},"response":[],"_postman_id":"17ab1e99-e6df-4ada-b658-0d3fd24397a7"}],"id":"da442e84-ec4c-404b-8c52-c1a2392ed694","_postman_id":"da442e84-ec4c-404b-8c52-c1a2392ed694","description":""}],"event":[{"listen":"prerequest","script":{"id":"f84b5ff7-338b-43d5-9a2e-a812e197889f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c7d3853c-5ec1-4c34-ae4d-4178316dbc4b","type":"text/javascript","packages":{},"exec":[""]}}]}