{ "item": [ { "id": "5feb573c-aefd-42bb-a8d0-d75d8029ca22", "name": "List", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e3104388-77f7-4353-9f53-059032fe7fbc", "name": "Get all lists", "request": { "name": "Get all lists", "description": {}, "url": { "path": [ "lists" ], "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": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "03bc822d-af6e-43a0-867c-b4c5f6156418", "name": "A paged collection of lists.", "originalRequest": { "url": { "path": [ "lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "100" }, { "key": "starting_after", "value": "" } ], "variable": [] }, "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 \"name\": \"New clients list\",\n \"double_opt_in\": false,\n \"fields\": [\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n },\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n }\n ],\n \"counts\": {\n \"pending\": 1,\n \"subscribed\": 10,\n \"unsubscribed\": 2\n },\n \"created_at\": \"2024-10-07T12:00:00+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"New clients list\",\n \"double_opt_in\": false,\n \"fields\": [\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n },\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n }\n ],\n \"counts\": {\n \"pending\": 1,\n \"subscribed\": 10,\n \"unsubscribed\": 2\n },\n \"created_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": "065873f0-bf36-4343-a46e-8d49b7a80a42", "name": "Create list", "request": { "name": "Create list", "description": {}, "url": { "path": [ "lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0bf6937-a773-4447-8c5c-d1a45b8bedc1", "name": "The created list.", "originalRequest": { "url": { "path": [ "lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "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 \"name\": \"New clients list\"\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 \"name\": \"New clients list\",\n \"double_opt_in\": false,\n \"fields\": [\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n },\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n }\n ],\n \"counts\": {\n \"pending\": 1,\n \"subscribed\": 10,\n \"unsubscribed\": 2\n },\n \"created_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be3d49b1-b8e9-4c95-a698-b55d96ad4d5b", "name": "Get list", "request": { "name": "Get list", "description": {}, "url": { "path": [ "lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "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": "edfdaf93-12c5-4a90-84e5-cce39fd5c313", "name": "The requested list.", "originalRequest": { "url": { "path": [ "lists", ":list_id" ], "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"New clients list\",\n \"double_opt_in\": false,\n \"fields\": [\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n },\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n }\n ],\n \"counts\": {\n \"pending\": 1,\n \"subscribed\": 10,\n \"unsubscribed\": 2\n },\n \"created_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8da6f775-2db9-479c-aaca-cefd0af04661", "name": "Update list", "request": { "name": "Update list", "description": {}, "url": { "path": [ "lists", ":list_id" ], "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 \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f2a39d02-609b-4ce0-87eb-950cf449ed2e", "name": "The updated list.", "originalRequest": { "url": { "path": [ "lists", ":list_id" ], "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 \"name\": \"New clients list\"\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 \"name\": \"New clients list\",\n \"double_opt_in\": false,\n \"fields\": [\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n },\n {\n \"label\": \"What is your hometown?\",\n \"tag\": \"Hometown\",\n \"type\": \"text\",\n \"choices\": [\n \"One\",\n \"Two\"\n ],\n \"fallback\": \"Unknown\"\n }\n ],\n \"counts\": {\n \"pending\": 1,\n \"subscribed\": 10,\n \"unsubscribed\": 2\n },\n \"created_at\": \"2024-10-07T12:00:00+00:00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f949045e-40ab-45f8-8e8c-f70857547993", "name": "Delete a list", "request": { "name": "Delete a list", "description": {}, "url": { "path": [ "lists", ":list_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "list_id", "description": "(Required) The ID of the list." } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "15a1e9d0-66d7-42cc-9fa4-d4dcad8ffad9", "name": "The list was deleted.", "originalRequest": { "url": { "path": [ "lists", ":list_id" ], "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 " } ], "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": "d63da8f0-4d1e-4601-84bb-f36ae143a5b2", "name": "EmailOctopus v2 Automation List 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" } } }