{ "item": [ { "id": "fafe56a7-5ced-4f7b-a8a4-7706f2d3619c", "name": "Contact", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "45f47c87-875f-4559-a7be-504242a554e8", "name": "Get contacts", "request": { "name": "Get contacts", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "100", "description": "The maximum number of records to return per page." }, { "disabled": false, "key": "starting_after", "value": "", "description": "A cursor for pagination; the ID of the last record on the previous page." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7020bd3b-cbcb-4a1c-a398-c9bc1cc09e6e", "name": "A paged collection of contacts.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "100" }, { "key": "starting_after", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n }\n ],\n \"paging\": {\n \"next\": \"/lists?limit=100&starting_after=00000000-0000-0000-0000-000000000000\",\n \"previous\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96e3baa9-1522-4d8d-85bc-55e8c592d61d", "name": "Create contact", "request": { "name": "Create contact", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email_address\": \"\",\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2238219d-864b-4152-896b-8515e97545de", "name": "The created contact.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"tags\": {\n \"vip\": true\n },\n \"status\": \"subscribed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b2b676a-0bee-496a-b1ae-833955ea09a0", "name": "Create or update contact", "request": { "name": "Create or update contact", "description": { "content": "Creates a contact, or updates it if a contact with the supplied email address already exists on the list.", "type": "text/plain" }, "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email_address\": \"\",\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "137c5231-bae3-4921-a33d-62ce4f4a28fe", "name": "The created or updated contact.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"tags\": {\n \"vip\": true\n },\n \"status\": \"subscribed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc5fe542-00ba-48cd-8f71-efd694e2fb4c", "name": "Update multiple list contacts", "request": { "name": "Update multiple list contacts", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"email_address\": \"\",\n \"fields\": {\n \"key_0\": 4935\n },\n \"tags\": {\n \"key_0\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"email_address\": \"\",\n \"fields\": {\n \"key_0\": 6110,\n \"key_1\": 3262.687890389987,\n \"key_2\": 8047\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"status\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b04f10dd-4664-486c-9b62-a07398c4f495", "name": "The result of each contact operation in the batch.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"tags\": {\n \"vip\": true\n },\n \"status\": \"subscribed\"\n },\n {\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"tags\": {\n \"vip\": true\n },\n \"status\": \"subscribed\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"email_address\": \"otto@example.com\",\n \"status\": \"success\"\n },\n {\n \"email_address\": \"otto@example.com\",\n \"status\": \"success\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88b59632-26d3-4896-977b-d49d6d65eb4d", "name": "Get contact", "request": { "name": "Get contact", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "06331ee1-c5a2-4d65-aef4-b19d223a454f", "name": "The requested contact.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c8de8ae-b7c6-4773-9b0e-4f498c086eb8", "name": "Update contact", "request": { "name": "Update contact", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email_address\": \"\",\n \"fields\": {\n \"key_0\": \"string\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6bd7fe4a-a241-4262-b329-65d1ba5890b7", "name": "The updated contact.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"tags\": {\n \"vip\": true\n },\n \"status\": \"subscribed\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"email_address\": \"otto@example.com\",\n \"fields\": {\n \"referral\": \"Otto\",\n \"birthday\": \"2015-12-01\"\n },\n \"status\": \"subscribed\",\n \"tags\": [\n \"vip\"\n ],\n \"created_at\": \"2024-10-07T12:00:00+00:00\",\n \"last_updated_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0e380b9-ea8a-4ff8-919f-a5196048b5aa", "name": "Delete contact", "request": { "name": "Delete contact", "description": {}, "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "79a2fe5e-674f-446e-8ba1-7d985e1fe2be", "name": "The contact was deleted.", "originalRequest": { "url": { "path": [ "lists", ":list_id", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." }, { "disabled": false, "type": "any", "value": "", "key": "contact_id", "description": "(Required) The ID of the contact (a UUID or the MD5 hash of the lowercased email)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.emailoctopus.com", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "_postman_id": "bbc3bd5c-d678-4ee2-a4af-e767c4cdb7c9", "name": "EmailOctopus v2 Automation Contact API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The EmailOctopus v2 REST API lets developers manage subscriber lists, contacts, custom fields, tags, campaigns, automations, and campaign reports. All requests are made over HTTPS to https://api.emailoctopus.com and authenticated with a Bearer API key in the Authorization header.\n\nContact Support:\n Name: EmailOctopus Support", "type": "text/plain" } } }