Manage contacts and lists.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23328196","collectionId":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","publishedId":"2s7YYscipP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-08T16:16:59.000Z"},"item":[{"name":"Contacts","item":[{"name":"List contacts","id":"7dda6c9d-95df-4b23-aaff-d84d13a1a002","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://e1.envoke.com/v1/contacts","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"67de81f8-8796-4424-bd29-618b347f6ac1","name":"List contacts","originalRequest":{"method":"GET","header":[],"url":"https://e1.envoke.com/v1/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 05 Oct 2022 01:16:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-Server","value":"z1a"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1234\",\n \"external_id\": \"6fbd84c021f720d708b26f7e400cb06b\",\n \"date_created\": \"2022-01-29T18:04:53+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"Contact\",\n \"last_name\": \"Example-One\",\n \"title\": \"\",\n \"email\": \"contact1@example.com\",\n \"company\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"en\",\n \"feedback\": \"\",\n \"consent_status\": \"Express\",\n \"consent_description\": \"Express consent contact API example\",\n \"consent_effective_date\": \"2022-01-29T18:04:53+00:00\",\n \"consent_expiry\": \"\",\n \"custom_fields\": [],\n \"interests\": [\n \"Newsletter\",\n \"Call requested\",\n \"Consumer\",\n \"Feb 16 list import\",\n \"long-haul\"\n ],\n \"autoresponders\": []\n },\n {\n \"id\": \"2345\",\n \"external_id\": \"da9994d13e9340a1009ab46338dcf302\",\n \"date_created\": \"2022-01-29T18:04:53+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"Contact\",\n \"last_name\": \"Example-Two\",\n \"title\": \"\",\n \"email\": \"contact2@example.com\",\n \"company\": \"\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"province\": \"\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Express\",\n \"consent_description\": \"Express consent contact API example\",\n \"consent_effective_date\": \"2022-01-29T18:04:53+00:00\",\n \"consent_expiry\": \"\",\n \"custom_fields\": {\n \"nick_name\": \"Michael\"\n },\n \"interests\": [\n \"Event invitations\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n }\n]"}],"_postman_id":"7dda6c9d-95df-4b23-aaff-d84d13a1a002"},{"name":"Get a single contact by ID","id":"3a12ae68-f6eb-44a7-bcbb-0f8e49d62ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://e1.envoke.com/v1/contacts/:id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts",":id"],"host":["e1","envoke","com"],"query":[],"variable":[{"type":"any","value":"695374","key":"id"}]}},"response":[{"id":"23fa87fd-dcd7-40cb-a4c8-bee068be7f11","name":"Get a single contact by ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://e1.envoke.com/v1/contacts/:id","protocol":"https","host":["e1","envoke","com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"695374"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Jan 2023 18:41:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-Server","value":"z1a"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"695374\",\n \"external_id\": \"1449e4ee3cd26f882f262a9a6ac072d8\",\n \"date_created\": \"2022-12-01T19:32:55+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact1@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"consent_effective_date\": \"2022-12-01T19:32:55+00:00\",\n \"consent_expiry\": \"2024-12-01\",\n \"custom_fields\": {\n \"birthday\": \"1984-03-14\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\",\n \"Ontario\",\n \"long-haul\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n}"}],"_postman_id":"3a12ae68-f6eb-44a7-bcbb-0f8e49d62ad9"},{"name":"Get contact by email","id":"82cf1269-650d-4387-961a-d3f1eb9829d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://e1.envoke.com/v1/contacts?email=contact1@example.com&limit=1","description":"This is example includes the &limit=1 parameter.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["e1","envoke","com"],"query":[{"key":"email","value":"contact1@example.com"},{"key":"limit","value":"1"}],"variable":[]}},"response":[{"id":"1a8c92f3-e77f-45ae-afcd-fc66e897ac5f","name":"Get contact by email","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://e1.envoke.com/v1/contacts?email=contact1@example.com&limit=1","protocol":"https","host":["e1","envoke","com"],"path":["v1","contacts"],"query":[{"key":"email","value":"contact1@example.com"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 09 Jan 2023 18:43:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-Server","value":"z1a"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"695374\",\n \"external_id\": \"1449e4ee3cd26f882f262a9a6ac072d8\",\n \"date_created\": \"2022-12-01T19:32:55+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact1@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"consent_effective_date\": \"2022-12-01T19:32:55+00:00\",\n \"consent_expiry\": \"2024-12-01\",\n \"custom_fields\": {\n \"birthday\": \"1984-03-14\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\",\n \"Ontario\",\n \"long-haul\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n}"}],"_postman_id":"82cf1269-650d-4387-961a-d3f1eb9829d9"},{"name":"Create a contact","id":"fa78600a-9412-4c52-86a5-dc8f487007d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://e1.envoke.com/v1/contacts","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"5162698b-2f69-4ad8-bef2-61c966704d77","name":"Create a contact","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"remote_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact-create@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"custom_fields\": {\n \"birthday\": \"1994-06-08\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://e1.envoke.com/v1/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 18 Jan 2023 21:49:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-Server","value":"z1b"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result_data\": {\n \"id\": \"695376\",\n \"external_id\": \"33c8b49115ce8e7e72cb063c40f039b9\",\n \"date_created\": \"2023-01-18T21:49:44+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact-create@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"consent_effective_date\": \"2023-01-18T21:49:44+00:00\",\n \"consent_expiry\": \"2025-01-18\",\n \"custom_fields\": {\n \"birthday\": \"1994-06-08\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\",\n \"Ontario\",\n \"long-haul\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n },\n \"result_text\": \"The contact was successfully created.\"\n}"}],"_postman_id":"fa78600a-9412-4c52-86a5-dc8f487007d2"},{"name":"Update a contact","id":"3040bf2d-4682-49fc-a097-49d22a293adc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://e1.envoke.com/v1/contacts","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"2843bf88-7496-41df-9acb-cde15021d622","name":"Update a contact","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"695376\",\n \"first_name\": \"Updated!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://e1.envoke.com/v1/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 18 Jan 2023 21:51:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-Server","value":"z1b"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result_data\": {\n \"id\": \"695376\",\n \"external_id\": \"33c8b49115ce8e7e72cb063c40f039b9\",\n \"date_created\": \"2023-01-18T21:49:44+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"Updated!\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact-create@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"consent_effective_date\": \"2023-01-18T21:49:44+00:00\",\n \"consent_expiry\": \"2025-01-18\",\n \"custom_fields\": {\n \"birthday\": \"1994-06-08\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\",\n \"Ontario\",\n \"long-haul\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n },\n \"result_text\": \"The contact was successfully updated.\"\n}"}],"_postman_id":"3040bf2d-4682-49fc-a097-49d22a293adc"},{"name":"Upsert a contact","id":"7aa4cf37-7b4e-41d9-b7fa-b20a0aff59bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://e1.envoke.com/v1/contacts?upsert=1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts"],"host":["e1","envoke","com"],"query":[{"key":"upsert","value":"1"}],"variable":[]}},"response":[{"id":"336eb519-51fa-48bc-b568-f3b0e07f6778","name":"Upsert a contact","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remote_id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact-create@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"custom_fields\": {\n \"birthday\": \"1994-06-08\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n}"},"url":{"raw":"https://e1.envoke.com/v1/contacts?upsert=1","protocol":"https","host":["e1","envoke","com"],"path":["v1","contacts"],"query":[{"key":"upsert","value":"1"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result_data\": {\n \"id\": \"695376\",\n \"external_id\": \"33c8b49115ce8e7e72cb063c40f039b9\",\n \"date_created\": \"2023-01-18T21:49:44+00:00\",\n \"remote_id\": \"\",\n \"first_name\": \"Updated!\",\n \"last_name\": \"\",\n \"title\": \"\",\n \"email\": \"contact-create@example.com\",\n \"company\": \"API Examples Inc.\",\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"city\": \"Toronto\",\n \"country\": \"CA\",\n \"province\": \"ON\",\n \"postal_code\": \"\",\n \"website\": \"\",\n \"language\": \"\",\n \"feedback\": \"\",\n \"consent_status\": \"Implied - Transaction\",\n \"consent_description\": \"Implied consent contact API example\",\n \"consent_effective_date\": \"2023-01-18T21:49:44+00:00\",\n \"consent_expiry\": \"2025-01-18\",\n \"custom_fields\": {\n \"birthday\": \"1994-06-08\"\n },\n \"interests\": [\n \"Consumer\",\n \"Segment B\",\n \"Ontario\",\n \"long-haul\"\n ],\n \"autoresponders\": [\n \"Welcome series\"\n ]\n },\n \"result_text\": \"The contact was successfully updated.\"\n}"}],"_postman_id":"7aa4cf37-7b4e-41d9-b7fa-b20a0aff59bb"},{"name":"CSV file upload for import sync","id":"9e555373-0efb-408f-8157-781d6ad42c9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"aad70e16-c5cc-4e66-abd8-c81057bda082","value":null}]},"url":"https://e1.envoke.com/v1/contacts/import/upload/sync","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","contacts","import","upload","sync"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"a93e6159-387e-4dd5-9746-fa12cf91c962","name":"Upsert a contact","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"ef92f3f2-a6d8-4c60-bd38-c366eefa9e94","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://e1.envoke.com/v1/contacts/import/upload/sync"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result_data\": {\n \"filepath\": \"/auto_import/1_test_20250729.csv\"\n },\n \"result_text\": \"File uploaded successfully\"\n}"}],"_postman_id":"9e555373-0efb-408f-8157-781d6ad42c9b"}],"id":"e09f5909-dec4-4e70-8ac1-6b18a2d20043","description":"Support documentation for Contacts API
\n","_postman_id":"e09f5909-dec4-4e70-8ac1-6b18a2d20043","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}}},{"name":"Customfields","item":[{"name":"List custom fields","id":"665e366e-d41a-4ace-b3d7-5e57069b1949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://e1.envoke.com/v2/customfields?limit=10&skip=0&fields=id,name,field_type&result_type=kvp","description":"Returns a paginated array of contact-scoped custom fields for the authenticated account. Use ?limit and ?skip for pagination. Use ?result_type=kvp for a flat id-to-name map.
Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp (shaped responses), the cap is lifted and an explicit limit above 100 is honoured as-is.
Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When omitted, all fields are returned. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,field_type"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"<id>\": \"<name>\" }) instead of an array of objects. Useful for populating dropdowns. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
Returns a single custom field by its ID.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"path":["customfields",":id"],"host":["https://e1.envoke.com/v2"],"query":[{"description":{"content":"Comma-separated list of fields to include in each response object. When omitted, all fields are returned. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,field_type"}],"variable":[{"id":"18789438-b4e9-4440-8801-d9de27d54ae1","description":{"content":"The unique ID of the custom field.
\n","type":"text/plain"},"type":"any","value":"4208","key":"id"}]}},"response":[{"id":"ae127321-f9c1-40b2-8af6-e7e4ca02b0d6","name":"The requested custom field.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCreates a new contact-scoped custom field. name and field_type are required. The field_type cannot be changed after creation.
Updates the name and/or description of an existing custom field. field_type cannot be changed after creation.
The unique ID of the custom field.
\n","type":"text/plain"},"type":"any","value":"4208","key":"id"}]}},"response":[{"id":"55e6de67-1384-445e-95dd-62cecb5eb901","name":"Custom field updated successfully. Returns the updated field object.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicPermanently deletes a custom field and all associated contact values. This action cannot be undone.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"path":["customfields",":id"],"host":["https://e1.envoke.com/v2"],"query":[],"variable":[{"id":"bd899dab-3f05-46cb-ae4e-b80b89d2958d","description":{"content":"The unique ID of the custom field.
\n","type":"text/plain"},"type":"any","value":"4208","key":"id"}]}},"response":[{"id":"b6db856f-4f1f-4960-b3bf-f13c88a3efd8","name":"Custom field deleted successfully.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReturns a paginated array of groups for the authenticated account and the specified item type, sorted alphabetically by name. Supports filtering by id, name, and parent_group. Use ?result_type=kvp for a flat id-to-name map.
Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp, the cap is lifted and an explicit limit above 100 is honoured as-is.
Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"<id>\": \"<name>\" }) instead of an array of objects. When set, the default limit increases to 100,000 and the hard cap is lifted.
Filter by group ID. Supports (ne) operator.
Filter by group name. Supports (ne) operator.
Filter by parent group name or numeric ID. Supports (ne) operator. Pass \"\" or 0 to filter for top-level groups only.
Sort by name. Value: asc or desc.
The item type whose groups are being managed.
\n","type":"text/plain"},"type":"any","value":"subscriptions","key":"type"}]}},"response":[{"id":"1d1c721f-f5a0-4863-b48b-5645c75b8e99","name":"A list of groups.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReturns a single group by its ID. Returns an empty array ([]) if the ID is not found.
Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name"}],"variable":[{"id":"74dd3c51-8c72-4b90-9827-6772322dac88","description":{"content":"The item type whose groups are being managed.
\n","type":"text/plain"},"type":"any","value":"subscriptions","key":"type"},{"id":"c34e3fe8-1e0f-4ac0-ab7b-eed3e4dd8e05","description":{"content":"The unique ID of the group.
\n","type":"text/plain"},"type":"any","value":"7741","key":"id"}]}},"response":[{"id":"85066638-c0dd-4bd9-9899-84a11fee3886","name":"The requested group, or an empty array if not found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCreates a new group of the specified type. name is required. Optionally nest the group under a parent by providing parent_group as a group name or ID. The parent must itself be a top-level group — only one level of nesting is supported.
The item type whose groups are being managed.
\n","type":"text/plain"},"type":"any","value":"subscriptions","key":"type"}]}},"response":[{"id":"8dbf0b6f-7873-40a6-bb8c-4e3d2d3317f6","name":"Group created successfully.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicUpdates one or more fields on an existing group. name and parent_group are updatable. If id is included in the body, it must match the {id} in the URL — if they differ, a validation envelope is returned. Pass null or \"\" for parent_group to promote the group to top-level.
The item type whose groups are being managed.
\n","type":"text/plain"},"type":"any","value":"subscriptions","key":"type"},{"id":"9fd3d4ab-65a9-4c32-907e-50ee7c174547","description":{"content":"The unique ID of the group.
\n","type":"text/plain"},"type":"any","value":"7741","key":"id"}]}},"response":[{"id":"aee60e0d-fadd-45a3-ad32-f962ea455503","name":"Group updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicPermanently deletes a group. The group must be empty — it cannot have subgroups or assigned items (tags, subscriptions, messages, or templates depending on type). The same validation error is returned in both cases. Remove all subgroups and reassign or delete all assigned items before deleting the group.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"path":["groups",":type",":id"],"host":["https://e1.envoke.com/v2"],"query":[],"variable":[{"id":"c15ed565-1516-47f5-80f7-39ef032dfdef","description":{"content":"The item type whose groups are being managed.
\n","type":"text/plain"},"type":"any","value":"subscriptions","key":"type"},{"id":"66943b62-21f9-413f-bbf8-5d5b2d20ee20","description":{"content":"The unique ID of the group.
\n","type":"text/plain"},"type":"any","value":"7741","key":"id"}]}},"response":[{"id":"731aa87f-d2e5-4608-9e40-af1968edfe64","name":"Group deleted, or a validation error.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicSupport documentation for Messages API
\n","_postman_id":"d2bf9ca2-cca0-4d59-be1f-8366663900a4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}}},{"name":"Send","item":[{"name":"Send a message","id":"f7e3e6d1-fdbe-43fb-835b-d7f72fb234e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://e1.envoke.com/v1/send","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","send"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"0a39400d-bb9f-41c1-a9bb-49fcb28469ea","name":"Send a message","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"subject\": \"API example send\",\n \"recipients\": [ \"example@api.com\" ],\n \"html\": \"World
\"\n}","options":{"raw":{"language":"json"}}},"url":"https://e1.envoke.com/v1/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 26 Nov 2024 15:10:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":"report-to envoke-csp; report-uri https://envoke.report-uri.com/r/d/csp/reportOnly; default-src * data: blob: about: 'unsafe-eval' 'unsafe-inline'; script-src 'self' 'unsafe-inline' 'unsafe-eval' https://files.envoke.com/web_files/812/scripts/nvk.js https://js.intercomcdn.com https://widget.intercom.io/widget/ev9a263d https://*.googletagmanager.com https://*.google-analytics.com https://w338l7p6z1nt.statuspage.io https://static.hotjar.com https://cdnjs.cloudflare.com/ajax/libs/ 'strict-dynamic' 'nonce-2a5b2a9f111d8c30c0dc52392cc85212' 'unsafe-hashes' 'sha256-Am38bprl7BQPJunroUzCTnX+UO/sZfvzxg5YpeXtH+o=' 'sha256-WeOXGDbPzjBm/bYHwPEmQ39Csa8Vi0OIxPeIg0U92Zk=' 'sha256-U2jHzcJroMbkJDy1d+p5YdXgm7A4+XRYRXKoZ2OoPw0=' 'sha256-ZkbfD9Ak1nuqO070B9P/o5dZt91kU4gvjxKYbG0pOEI=' 'sha256-2rvfFrggTCtyF5WOiTri1gDS8Boibj4Njn0e+VCBmDI=';"},{"key":"X-Server","value":"z1b"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result_text\": \"Message is sending\",\n \"result_data\": {\n \"id\": 123456,\n \"new_contacts_created\": 0,\n \"summary\": {\n \"total_selected\": 1,\n \"emails_to_be_sent\": 1,\n \"excluded_unsubscribed_contacts\": 0,\n \"excluded_invalid_emails\": 0,\n \"excluded_bounced_emails\": 0,\n \"excluded_unverified_emails\": 0\n },\n \"recipients\": [\n {\n \"id\": 654321,\n \"email\": \"example@api.com\",\n \"emails_to_be_sent\": true\n }\n ]\n }\n}"}],"_postman_id":"f7e3e6d1-fdbe-43fb-835b-d7f72fb234e9"}],"id":"6f729432-cdd3-4de4-b374-54ec83d2a0d8","description":"Support documentation for Messages API
\n","_postman_id":"6f729432-cdd3-4de4-b374-54ec83d2a0d8","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}}},{"name":"Senders","item":[{"name":"List sender identities","id":"d3ac0d6f-4a9e-4e67-acbb-93ca3508f180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://e1.envoke.com/v1/senders?limit=10&skip=0&fields=id,name,email&result_type=kvp&filter[id]=string&filter[name]=string&filter[email]=string&filter[is_default]=1","description":"Returns a paginated array of sender identities for the authenticated account. Supports filtering by id, name, email, and is_default. Note: sorting is not currently supported.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders"],"host":["e1","envoke","com"],"query":[{"description":{"content":"Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp, the cap is lifted and an explicit limit above 100 is honoured as-is.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,email"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"\": \"\" }) instead of an array of objects. When set, the default limit increases to 100,000 and the hard cap is lifted.
\n","type":"text/plain"},"key":"result_type","value":"kvp"},{"description":{"content":"Filter by sender ID. Supports operators: (ne).
Filter by sender display name. Supports operators: (ne).
Filter by sender email address. Supports operators: (ne).
Filter by default status. Use 1 to return only the default sender, 0 to return only non-default senders.
\n","type":"text/plain"},"key":"filter[is_default]","value":"1"}],"variable":[]}},"response":[{"id":"4d8c837d-5130-43e3-8755-0bd0f9cf69d6","name":"A list of sender identities.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicReturns a single sender identity by ID. Returns an empty array ([]) if the ID is not found.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders",":id"],"host":["e1","envoke","com"],"query":[{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,email"}],"variable":[{"description":{"content":"The unique ID of the sender identity.
\n","type":"text/plain"},"type":"any","value":"9315","key":"id"}]}},"response":[{"id":"ff77b7dc-4cc3-47d6-9e81-4fbb689e4dbe","name":"The requested sender identity, or an empty array if not found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicCreates a new sender identity. Both name and email are required. The first identity created is automatically set as the account's default.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"4c69cdad-29b3-44d9-a327-2bc944bf0482","name":"Sender created successfully.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicUpdates the name and/or email of an existing sender identity. At least one field must be provided. id and is_default are read-only and cannot be changed via PATCH — to change the default sender use POST /senders/{id}/default. If id is included in the request body it must match the {id} in the URL.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders",":id"],"host":["e1","envoke","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the sender identity.
\n","type":"text/plain"},"type":"any","value":"9315","key":"id"}]}},"response":[{"id":"a639fb54-50e5-4c1c-8dff-516485eb45c0","name":"Sender updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicPromotes the specified sender identity to be the account's default. Clears the default flag from all other identities and syncs the account's default From name and email. The default sender is used automatically when no sender is explicitly specified in a campaign.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders",":id","default"],"host":["e1","envoke","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the sender identity.
\n","type":"text/plain"},"type":"any","value":"9315","key":"id"}]}},"response":[{"id":"3250d7fa-f091-4b3c-8307-a774dfdbf25c","name":"Default sender updated successfully.","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicPermanently deletes a sender identity. The default sender cannot be deleted — use POST /senders/{id}/default to promote a different identity first.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","senders",":id"],"host":["e1","envoke","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the sender identity.
\n","type":"text/plain"},"type":"any","value":"9315","key":"id"}]}},"response":[{"id":"b3dcacc1-2627-4da2-a21a-e5030e5d04bc","name":"Sender deleted successfully.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicReturns a paginated array of subscriptions for the authenticated account, sorted alphabetically by name by default. Supports filtering by id, name, external_id, group, and prefpage_access. Use ?result_type=kvp for a flat id-to-name map. Filter operators supported: exact match and (ne) (not equal).
Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp, the cap is lifted and an explicit limit above 100 is honoured as-is.
Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,group"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"<id>\": \"<name>\" }) instead of an array of objects. When set, the default limit increases to 100,000 and the hard cap is lifted.
Filter by subscription ID. Supports (ne) operator.
Filter by subscription name. Supports (ne) operator.
Filter by external ID. Supports (ne) operator.
Filter by group name. Supports (ne) operator.
Filter by preference page access. Supports (ne) operator.
Sort by name. Value: asc or desc.
Returns a single subscription by its ID. Returns an empty array ([]) if the ID is not found.
Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,group"}],"variable":[{"id":"cd5dfb1c-d805-47e1-a4e5-ba7e81bb67b3","description":{"content":"The unique ID of the subscription.
\n","type":"text/plain"},"type":"any","value":"6823","key":"id"}]}},"response":[{"id":"71a0f005-4543-4c6c-a88b-1adc93c26553","name":"The requested subscription, or an empty array if not found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCreates a new subscription. name is required. Optional fields: group, prefpage_access, display_names, display_descriptions.
Updates one or more fields on an existing subscription. name, group, prefpage_access, display_names, and display_descriptions are updatable. external_id is silently ignored if included. If id is included in the body, it must match the {id} in the URL — if they differ, a validation envelope is returned.
The unique ID of the subscription.
\n","type":"text/plain"},"type":"any","value":"6823","key":"id"}]}},"response":[{"id":"edc59670-3fb1-4f88-a305-d53f0db241fd","name":"Subscription updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicPermanently deletes a subscription. The subscription must have no contacts assigned to it — attempting to delete one with contacts assigned returns a validation error. Remove all contacts first using the DELETE /subscriptions/{id}/contacts endpoint.
The unique ID of the subscription.
\n","type":"text/plain"},"type":"any","value":"6823","key":"id"}]}},"response":[{"id":"fe386d04-116d-422e-97fc-d9ebfe4756ac","name":"Subscription deleted successfully, or a validation error.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicBulk-assigns contacts to a subscription. Accepts either contact_ids or contact_emails (not both). Maximum 1,000 items per request. The operation is idempotent — adding a contact that is already subscribed is a no-op.
The unique ID of the subscription.
\n","type":"text/plain"},"type":"any","value":"6823","key":"id"}]}},"response":[{"id":"2ff1c603-ec81-4d4b-b158-d13c62768b54","name":"Operation completed. Check `success` and `result_data` for details.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicBulk-removes contacts from a subscription. Accepts either contact_ids or contact_emails (not both). Maximum 1,000 items per request. The operation is idempotent — removing a contact that is not subscribed is a no-op.
The unique ID of the subscription.
\n","type":"text/plain"},"type":"any","value":"6823","key":"id"}]}},"response":[{"id":"e9144ab0-3ae9-442e-aa24-dafabb3e817f","name":"Operation completed. Check `success` and `result_data` for details.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReturns a paginated array of tags for the authenticated account, sorted alphabetically by name by default. Supports filtering by id, name, external_id, group, and description. Use ?result_type=kvp for a flat id-to-name map. Filter operators supported: exact match and (ne) (not equal).
Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp, the cap is lifted and an explicit limit above 100 is honoured as-is.
Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,group"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"<id>\": \"<name>\" }) instead of an array of objects. When set, the default limit increases to 100,000 and the hard cap is lifted.
Filter by tag ID. Supports (ne) operator.
Filter by tag name. Supports (ne) operator.
Filter by external ID. Supports (ne) operator.
Filter by group name. Supports (ne) operator.
Filter by description. Supports (ne) operator.
Sort by name. Value: asc or desc.
Returns a single tag by its ID. Returns an empty array ([]) if the ID is not found.
Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,group"}],"variable":[{"id":"d5c0639f-9614-49c9-97f6-5e1546eee09d","description":{"content":"The unique ID of the tag.
\n","type":"text/plain"},"type":"any","value":"8955","key":"id"}]}},"response":[{"id":"f63d7eb2-ffdd-4a48-98f1-8f4683ed7243","name":"The requested tag, or an empty array if not found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCreates a new tag. name is required. Optional fields: group, description, display_names.
Updates one or more fields on an existing tag. name, group, description, and display_names are updatable. external_id is silently ignored if included. If id is included in the body, it must match the {id} in the URL — if they differ, a validation envelope is returned.
The unique ID of the tag.
\n","type":"text/plain"},"type":"any","value":"8955","key":"id"}]}},"response":[{"id":"9fb25c78-31f2-4f4b-b68b-43d3ee4cfb11","name":"Tag updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicPermanently deletes a tag and all contact-to-tag associations. Contacts are not deleted — they simply lose their assignment to this tag.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"path":["tags",":id"],"host":["https://e1.envoke.com/v2"],"query":[],"variable":[{"id":"deeb0e86-73c6-4b89-9566-a382626eda26","description":{"content":"The unique ID of the tag.
\n","type":"text/plain"},"type":"any","value":"8955","key":"id"}]}},"response":[{"id":"982c5e2e-5c91-4f19-a481-8f8b036cc7e4","name":"Tag deleted successfully.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicBulk-assigns contacts to a tag. Accepts either contact_ids or contact_emails (not both). Maximum 1,000 items per request. The operation is idempotent — adding a contact that is already tagged is a no-op.
The unique ID of the tag.
\n","type":"text/plain"},"type":"any","value":"8955","key":"id"}]}},"response":[{"id":"9c9c8c50-f5bd-444a-8f42-81383b9f2dc6","name":"Operation completed. Check `success` and `result_data` for details.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicBulk-removes contacts from a tag. Accepts either contact_ids or contact_emails (not both). Maximum 1,000 items per request. The operation is idempotent — removing a contact that is not tagged is a no-op.
The unique ID of the tag.
\n","type":"text/plain"},"type":"any","value":"8955","key":"id"}]}},"response":[{"id":"ed6a7ad5-cf83-4b12-a6aa-a76f9cb2a697","name":"Operation completed. Check `success` and `result_data` for details.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReturns a paginated array of templates for the authenticated account, sorted by most recently modified first by default. Supports sorting via sort[] query parameters. Supports filtering by id, name, status, language, and group. Use ?result_type=kvp for a flat id-to-name map.
Maximum number of records to return. Default is 10, hard cap is 100. When used alongside ?fields= or ?result_type=kvp, the cap is lifted and an explicit limit above 100 is honoured as-is.
Number of records to skip. Used for pagination.
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,status"},{"description":{"content":"Set to kvp to receive results as a flat key-value object ({ \"<id>\": \"<name>\" }) instead of an array of objects. When set, the default limit increases to 100,000 and the hard cap is lifted.
Filter by template name. Supports operators: (ne), (in).
Filter by status. Valid values: published, unpublished.
Filter by language. Accepts a two-letter IETF code (e.g. en, fr).
Filter by group name.
\n","type":"text/plain"},"key":"filter[group]","value":"string"},{"description":{"content":"Filter by template ID.
\n","type":"text/plain"},"key":"filter[id]","value":"9627"},{"description":{"content":"Sort by name. Value: asc or desc.
Sort by last modified time. Value: asc or desc.
Sort by creation time. Value: asc or desc.
Sort by language. Value: asc or desc.
Sort by group name. Value: asc or desc.
Sort by status. Value: asc or desc.
Returns a single template by its ID. Add ?include_html=1 to include the full HTML content in the response.
Set to 1 to include the full HTML content in a single-template response. Has no effect on list requests.
Comma-separated list of fields to include in each response object. When set, the default limit increases to 100,000 and the 100-record hard cap is lifted.
\n","type":"text/plain"},"key":"fields","value":"id,name,status"}],"variable":[{"id":"9a7eceea-7292-41f6-afa4-7e936bfc5b15","description":{"content":"The unique ID of the template.
\n","type":"text/plain"},"type":"any","value":"8884","key":"id"}]}},"response":[{"id":"ffc201a4-ced6-4ddb-a24a-131d914c73bd","name":"The requested template. Includes `html` field only when `?include_html=1` is set.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCreates a new email template. Either html or template_id must be provided. name is optional — if omitted, it is auto-generated as API Template {timestamp}. New templates are always created with status: published regardless of any status value in the request body.
Updates one or more fields on an existing template. name, status, language, group, and html are updatable. external_id, preview_url, create_time, and modified_time are silently ignored if included. If id is included in the request body, it must match the {id} in the URL — if they differ, a validation error is returned.
The unique ID of the template.
\n","type":"text/plain"},"type":"any","value":"8884","key":"id"}]}},"response":[{"id":"4509b299-6ef8-45c1-b1e5-2ef8df956332","name":"Template updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicSoft-deletes a template. The template is archived and no longer returned by the API, but the underlying data is not immediately purged.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"path":["templates",":id"],"host":["https://e1.envoke.com/v2"],"query":[],"variable":[{"id":"6a868b7b-a95a-4d20-917f-79c98c5c4f30","description":{"content":"The unique ID of the template.
\n","type":"text/plain"},"type":"any","value":"8884","key":"id"}]}},"response":[{"id":"72829cf7-3664-4739-b77b-42dbe7c8ff54","name":"Template deleted successfully.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReturns all webhook subscriptions for the authenticated account. All subscriptions are returned by default (no limit). Supports filtering by type, pagination, and field selection.
Maximum number of subscriptions to return. When omitted, all subscriptions are returned.
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Number of records to skip. Used with limit for pagination.
Comma-separated list of fields to include in each response object.
\n","type":"text/plain"},"key":"fields","value":"id,type,url"},{"description":{"content":"Filter results to subscriptions matching the given event type.
\n","type":"text/plain"},"key":"type","value":"preference_page_submission"}],"variable":[]}},"response":[{"id":"fa738ed2-c460-4646-9684-de42185a5b66","name":"An array of webhook subscriptions. Returns `[]` if none exist.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicReturns a single webhook subscription by its ID. Returns null if the ID is not found.
Creates a new webhook subscription. type and url are required. filter is optional — omit it or pass {} to receive all events of the given type.
Returns HTTP 201 on success. Returns HTTP 400 with a duplicate error if a subscription with the same type and url already exists.
Permanently deletes a webhook subscription. No further events are delivered once deleted. The operation is idempotent — deleting a non-existent ID returns a success response.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","hooks","{{id}}.json"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"48f4bac5-5523-461b-bcab-83d9bb69da57","name":"Subscription deleted (or did not exist — deletion is idempotent).","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BasicReturn stats about email campaigns including: sends, opens, clicks, bounces, revoked_consent.
\nSupport documentation for Reports API
\n\n\n","_postman_id":"afe3656d-f41e-42a5-b892-f79c7185c14e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}}},{"name":"Send emails (legacy)","item":[{"name":"Send single email","id":"18a44a61-887a-4cc6-b6e6-b3ff5e4719d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://e1.envoke.com/api/v4legacy/send/SendEmails.json","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v4legacy","send","SendEmails.json"],"host":["e1","envoke","com"],"query":[],"variable":[]}},"response":[{"id":"9cefcede-e946-43cb-a2f9-cdb0e67b1223","name":"Send single email","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"SendEmails\": [\n {\n \"EmailDataArray\": [\n {\n \"email\": [\n {\n \"to_email\": \"name@domain.com\",\n \"to_name\": \"John Doe\",\n \"from_email\": \"info@acme.com\",\n \"from_name\": \"Acme Info\",\n \"reply_email\": \"noreply@acme.com\",\n \"reply_name\": \"No reply\",\n \"message_subject\": \"Test API send\",\n \"message_html\": \"This is an HMTL email sent to: {email} via the Envoke Send Emails API\",\n \"message_text\": \"This is a text version equivalent sent to: {email} via the Envoke Emails API\"\n }\n ]\n }\n ]\n }\n ]\n}"},"url":"https://e1.envoke.com/api/v4legacy/send/SendEmails.json"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"result_type\": \"0\",\n \"result_value\": \"true\",\n \"result_data\": [\n {\n \"response\": [\n {\n \"request_type\": \"send\",\n \"request_id\": \"name@domain.com\",\n \"response_type\": 0,\n \"response_value\": \"true\",\n \"response_data\": \"1234\",\n \"response_text\": \"TRUE: Request successful, email sent to: name@domain.com\"\n }\n ]\n }\n ],\n \"result_text\": \"TRUE: Request successful, 1 email(s) sent\"\n }\n]"}],"_postman_id":"18a44a61-887a-4cc6-b6e6-b3ff5e4719d4"}],"id":"551896ad-3374-4e20-8e15-7e8f90150ce9","description":"The reporting API is currently a beta release. Beta features are early releases that are still a bit rough around the edges. They are fully functional, but aspects may be subject to change. In the case of APIs this may include breaking changes to field names, endpoints, or attribution logic. Through our customers' usage and feedback of beta features we gain insights about how to finalize development.
\n
IMPORTANT: This API is deprecated and supported only for existing integrations.
\nUse the modern send API instead.
\nThe Send emails API can be used to send out transactional emails from outside the Envoke user interface.
\nSupport documentation for Send emails API
\n","_postman_id":"551896ad-3374-4e20-8e15-7e8f90150ce9","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]},"isInherited":true,"source":{"_postman_id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","id":"e7cddb3b-4b7a-44b1-b702-66624b7bcb57","name":"Envoke API documentation","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{BasicAuthUser}}"},{"key":"password","value":"{{BasicAuthPass}}"}]}},"event":[{"listen":"prerequest","script":{"id":"14b5ae91-b549-40a3-8436-2a15489d5d26","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"063d8e01-358f-4bdf-98cf-4bad8b4814fb","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://e1.envoke.com/v2"}]}