{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.wavo.co" } ], "info": { "name": "Wavo API Reference", "_postman_id": "74b73631-fa82-4d0d-9c76-cca6ce472c29", "description": "Wavo Platform API reference", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Campaigns", "description": "\nAPIs for managing campaigns.", "item": [ { "name": "Display a listing of campaigns", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns", "query": [ { "key": "client_id", "value": "ah83445df46as5432mga", "description": "The id of a client.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/campaigns?client_id=ah83445df46as5432mga" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all campaigns accessible by a user.\nIf used by an agency with white-label dashboard subscription, an optional client_id parameter can be defined to return the campaigns of a specific client." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"o6djr143n59olm2y9kez\",\"name\":\"Roberts PLC 9\",\"timezone\":\"US\\\/Mountain\",\"status\":\"DRAFT\",\"created_at\":1775474086,\"client\":{\"id\":\"41z52kqnwjz4oxplrv80\",\"name\":\"Roberts PLC\",\"max_emails\":3,\"created_at\":1775474086}},{\"id\":\"028p65r9le3d7em4owqv\",\"name\":\"Robel and Sons 10\",\"timezone\":\"US\\\/Mountain\",\"status\":\"DRAFT\",\"created_at\":1775474086,\"client\":{\"id\":\"xvey7lp3gzlnw408zr9n\",\"name\":\"Robel and Sons\",\"max_emails\":3,\"created_at\":1775474086}}]}", "name": "" } ] }, { "name": "Create a new campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"aut\",\"client_id\":\"4a83445df46as5432mga\",\"timezone\":\"US\\\/Mountain\"}" }, "description": "Create a new campaign for a client." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"jxv8qkeml4dml1g69y3w\",\"name\":\"Satterfield and Sons 11\",\"timezone\":\"US\\\/Mountain\",\"status\":\"DRAFT\",\"created_at\":1775474086,\"client\":{\"id\":\"dxj2z7kno3l7o9lyv5qp\",\"name\":\"Satterfield and Sons\",\"max_emails\":3,\"created_at\":1775474086}}}", "name": "" } ] }, { "name": "Fetch the daily campaign stats of a campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:campaign_id\/daily-stats", "query": [ { "key": "start", "value": "1662940800", "description": "The timestamp after which to show stats.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:campaign_id\/daily-stats?start=1662940800", "variable": [ { "id": "campaign_id", "key": "campaign_id", "value": "1", "description": "The ID of the campaign." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all daily campaign stats of a campaign.\nTo limit results, a query parameter `start` can be sent, so that the response contains only stats for days after a specific timestamp." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"day\": \"2022-09-12T00:00:00.000000Z\",\n \"contacted\": 11,\n \"replied\": 1,\n \"autoreplied\": 0,\n \"bounced\": 4,\n \"positive\": 1,\n \"neutral\": 0,\n \"negative\": 4,\n \"messages_clicked\": 5,\n \"messages_opened\": 0,\n \"messages_sent\": 15\n },\n {\n \"day\": \"2022-09-13T00:00:00.000000Z\",\n \"contacted\": 15,\n \"replied\": 3,\n \"autoreplied\": 1,\n \"bounced\": 2,\n \"positive\": 2,\n \"neutral\": 1,\n \"negative\": 2,\n \"messages_clicked\": 6,\n \"messages_opened\": 0,\n \"messages_sent\": 17\n }\n ]\n}", "name": "" } ] }, { "name": "Fetch the total stats of a campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:campaign_id\/stats", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:campaign_id\/stats", "variable": [ { "id": "campaign_id", "key": "campaign_id", "value": "1", "description": "The ID of the campaign." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"contacted\": 5,\n\"replied\": 1,\n\"autoreplied\": 0,\n\"bounced\": 0,\n\"positive\": 1,\n\"neutral\": 0,\n\"negative\": 0,\n\"messages_clicked\": 0,\n\"messages_opened\": 0,\n\"messages_sent\": 5,\n\"campaign_steps\": [\n{\n\"number\": 1,\n\"sent\": 5,\n\"queued\": 0,\n\"contacted\": 5,\n\"replied\": 1,\n\"positive\": 1,\n\"bounced\": 0,\n\"messages_clicked\": 0,\n\"messages_opened\": 0\n},\n{\n\"number\": 2,\n\"sent\": 0,\n\"queued\": 4,\n\"contacted\": 0,\n\"replied\": 0,\n\"positive\": 0,\n\"bounced\": 0,\n\"messages_clicked\": 0,\n\"messages_opened\": 0\n}\n]\n}\n}", "name": "" } ] } ] }, { "name": "Clients", "description": "\nAPIs for managing clients.", "item": [ { "name": "Display a user's accessible clients", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This will return an array of 1 or more clients (for users on white-label dashboard subscription)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"8lm2405kom38w6vyz7j3\",\"name\":\"Roberts PLC\",\"max_emails\":3,\"created_at\":1775474086},{\"id\":\"kn9x5qyro03ko4z6pd37\",\"name\":\"Feeney LLC\",\"max_emails\":3,\"created_at\":1775474086}]}", "name": "" } ] }, { "name": "Create a new client", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Thompson LLC\",\"max_emails\":3}" }, "description": "Add a new client to the user's agency" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": \"l8re092o9qv7w745jmpk\",\n \"name\": \"Thompson LLC\",\n \"max_emails\": 3,\n \"created_at\": 1580411327\n }\n}", "name": "" } ] }, { "name": "Display a client's users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:client_id\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:client_id\/users", "variable": [ { "id": "client_id", "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show all active users of a client as well as pending user invitations, with their assigned roles." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"users\": [\n {\n \"name\": \"Mike Jones\",\n \"email\": \"mike@wavo.co\",\n \"created_at\": 1580412998,\n \"roles\": [\n \"view_campaigns\"\n ]\n },\n {\n \"name\": \"Bill Scott\",\n \"email\": \"bill@wavo.co\",\n \"created_at\": 1580412998,\n \"roles\": [\n \"view_campaigns\",\n \"create_campaigns\"\n ]\n }\n ],\n \"invitations\": [\n {\n \"email\": \"mike1@wavo.co\",\n \"created_at\": 1580412998,\n \"roles\": [\n \"create_campaigns\",\n \"export_data\",\n \"view_campaigns\"\n ]\n }\n ]\n }\n}", "name": "" } ] }, { "name": "Add a new client user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:client_id\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:client_id\/users", "variable": [ { "id": "client_id", "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"mike@wavo.co\",\"view_campaigns\":true,\"create_campaigns\":true,\"export_campaigns\":true}" }, "description": "Add a new user to a client. Specify the user's email address and the roles he should have.\nAvailable roles are:\n- view_campaigns\n- create_campaigns\n- export_campaigns" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"An invitation was sent to mike@wavo.co\"\n}", "name": "" } ] }, { "name": "Update a client user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:client_id\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:client_id\/users", "variable": [ { "id": "client_id", "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"mike@wavo.co\",\"view_campaigns\":true,\"create_campaigns\":true,\"export_campaigns\":true}" }, "description": "Update a client user's roles. Can update roles of active users or user invitations.\nAvailable roles are:\n- view_campaigns\n- create_campaigns\n- export_campaigns" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Success. Updated user roles.\"\n}", "name": "" } ] }, { "name": "Delete a client user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:client_id\/users", "query": [ { "key": "email", "value": "mike%40wavo.co", "description": "The email address of the user.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/clients\/:client_id\/users?email=mike%40wavo.co", "variable": [ { "id": "client_id", "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a user from a client." }, "response": [ { "header": [], "code": 204, "body": "{\n}", "name": "" } ] } ] }, { "name": "Contacts", "description": "\nAPIs for managing contacts.", "item": [ { "name": "Create a new contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"campaign_id\":\"fkjtf4390kfgu8903nsk\",\"email\":\"daugherty.elsie@example.org\",\"first_name\":\"aut\",\"last_name\":\"aut\",\"company\":\"aut\",\"industry\":\"aut\",\"website\":\"aut\",\"title\":\"aut\",\"phone\":\"aut\",\"address\":\"aut\",\"city\":\"aut\",\"state\":\"aut\",\"country\":\"aut\",\"custom_merge_fields[]\":null}" }, "description": "A new contact can be attached to an existing campaign. As such the campaign_id is required" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": [\n {\n \"id\": \"we52o4rv130mz1qxyzk8pmljd\",\n \"email\": \"aditya.kohler@example.org\",\n \"first_name\": \"Aditya\",\n \"last_name\": \"Kohler\",\n \"company\": \"Gerlach, Ziemann and Reilly\",\n \"industry\": \"Nonprofit Organization Management\",\n \"website\": \"kunde.com\",\n \"title\": \"Ms.\",\n \"phone\": \"219-959-5166\",\n \"address\": \"41164 Osvaldo Row\",\n \"city\": \"Baileyborough\",\n \"state\": \"New Hampshire\",\n \"country\": \"US\",\n \"custom_merge_fields\": {\n \"fav color\": \"purple\",\n \"sport\": \"running\",\n \"os\": \"Windows NT 5.0\"\n },\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"OK\",\n \"interest\": null,\n \"emails_sent\": 0,\n \"completed_steps\": 0,\n \"is_missing_data\": false,\n \"is_suppressed\": false,\n \"created_at\": 1579888600,\n \"campaign\": {\n \"id\": \"fkjtf4390kfgu8903nsk\",\n \"name\": \"Grady-Runolfsson 16\",\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"DRAFT\",\n \"created_at\": 1579888600,\n \"client\": {\n \"id\": \"a83445df46as5432mga\",\n \"name\": \"Grady-Runolfsson\",\n \"created_at\": 1579888600\n }\n }\n }\n\t]\n}", "name": "" } ] }, { "name": "Display a contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "we52o4rv130mz1qxyzk8pmljd", "description": "The id of the contact." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find a contact by id and display its details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"we52o4rv130mz1qxyzk8pmljd\",\n \"email\": \"aditya.kohler@example.org\",\n \"first_name\": \"Aditya\",\n \"last_name\": \"Kohler\",\n \"company\": \"Gerlach, Ziemann and Reilly\",\n \"industry\": \"Nonprofit Organization Management\",\n \"website\": \"kunde.com\",\n \"title\": \"Ms.\",\n \"phone\": \"219-959-5166\",\n \"address\": \"41164 Osvaldo Row\",\n \"city\": \"Baileyborough\",\n \"state\": \"New Hampshire\",\n \"country\": \"US\",\n \"custom_merge_fields\": {\n \"fav color\": \"purple\",\n \"sport\": \"running\",\n \"os\": \"Windows NT 5.0\"\n },\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"OK\",\n \"interest\": null,\n \"emails_sent\": 0,\n \"completed_steps\": 0,\n \"is_missing_data\": false,\n \"is_suppressed\": false,\n \"created_at\": 1579888600,\n \"campaign\": {\n \"id\": \"fkjtf4390kfgu8903nsk\",\n \"name\": \"Grady-Runolfsson 16\",\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"DRAFT\",\n \"created_at\": 1579888600,\n \"client\": {\n \"id\": \"a83445df46as5432mga\",\n \"name\": \"Grady-Runolfsson\",\n \"created_at\": 1579888600\n }\n }\n }\n}", "name": "" } ] }, { "name": "Update contact interest", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contact-interest", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contact-interest" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":\"fkjtf4390kfgu8903nsk\",\"interest\":\"POSITIVE\"}" }, "description": "Set a contact's interest to a value of POSITIVE, NEUTRAL, or NEGATIVE." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Interest updated.\"\n}", "name": "" } ] }, { "name": "Remove contact interest", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contact-interest", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contact-interest" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":\"fkjtf4390kfgu8903nsk\"}" }, "description": "Set a contact's interest to UNMARKED." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Interest UNMARKED.\"\n}", "name": "" } ] }, { "name": "Display a listing of contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:campaign_id\/contacts", "query": [ { "key": "status", "value": "replied", "description": "Get contacts of a specific status. Can be one of: ok, replied, unsubscribed, bounced, autoreplied, stopped.", "disabled": false }, { "key": "is_missing_data", "value": "0", "description": "Get contacts with missing data.", "disabled": true }, { "key": "is_suppressed", "value": "1", "description": "Get contacts that are suppressed.", "disabled": false }, { "key": "interest", "value": "positive", "description": "Get contacts that have a specific interest level. Can be one of: unmarked, positive, neutral, negative.", "disabled": false }, { "key": "emails_sent", "value": "3", "description": "Get contacts that have been contacted a specific number of times.", "disabled": false }, { "key": "limit", "value": "2", "description": "The number of objects to return. Defaults to 100. Maximum 500.", "disabled": false }, { "key": "offset", "value": "0", "description": "The zero-based offset for the default object sorting.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:campaign_id\/contacts?status=replied&is_missing_data=0&is_suppressed=1&interest=positive&emails_sent=3&limit=2&offset=0", "variable": [ { "id": "campaign_id", "key": "campaign_id", "value": "fkjtf4390kfgu8903nsk", "description": "The id of a campaign." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all contacts of a campaign." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"j5ropgvndm6l1v0z7lwe9481y\",\n \"email\": \"corwin.velda@example.com\",\n \"first_name\": \"Vincent\",\n \"last_name\": \"Kemmer\",\n \"company\": \"Hartmann, Lockman and Thompson\",\n \"industry\": \"Luxury Goods & Jewelry\",\n \"website\": \"mosciski.com\",\n \"title\": \"Mr.\",\n \"phone\": \"1-213-895-2923\",\n \"address\": \"6166 Jakubowski Cliff Suite 605\",\n \"city\": \"Port Reidville\",\n \"state\": \"North Carolina\",\n \"country\": \"US\",\n \"custom_merge_fields\": {\n \"fav color\": \"teal\",\n \"sport\": \"tennis\",\n \"os\": \"Windows NT 6.2\"\n },\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"OK\",\n \"interest\": null,\n \"emails_sent\": 1,\n \"completed_steps\": 1,\n \"is_missing_data\": 1,\n \"is_suppressed\": 0,\n \"created_at\": 1579888424\n },\n {\n \"id\": \"ny4j2vd8k56248q1wzgeo9r3p\",\n \"email\": \"mschowalter@example.com\",\n \"first_name\": \"Jacquelyn\",\n \"last_name\": \"Okuneva\",\n \"company\": \"Armstrong, Ferry and Nolan\",\n \"industry\": \"Design\",\n \"website\": \"sanford.com\",\n \"title\": \"Prof.\",\n \"phone\": \"(828) 344-5044 x05539\",\n \"address\": \"1971 Colten Ways\",\n \"city\": \"Batzland\",\n \"state\": \"Kansas\",\n \"country\": \"US\",\n \"custom_merge_fields\": {\n \"fav color\": \"silver\",\n \"sport\": \"tennis\",\n \"os\": \"Windows 95\"\n },\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"REPLIED\",\n \"interest\": \"POSITIVE\",\n \"emails_sent\": 2,\n \"completed_steps\": 2,\n \"is_missing_data\": 1,\n \"is_suppressed\": 0,\n \"created_at\": 1579888424\n }\n ]\n}", "name": "" } ] }, { "name": "Search for contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [ { "key": "email", "value": "aditya.kohler%40example.org", "description": "The email address we are searching for.", "disabled": false }, { "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client.", "disabled": false }, { "key": "campaign_id", "value": "fkjtf4390kfgu8903nsk", "description": "The id of a campaign.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts?email=aditya.kohler%40example.org&client_id=a83445df46as5432mga&campaign_id=fkjtf4390kfgu8903nsk" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find contacts of a specific email address." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"we52o4rv130mz1qxyzk8pmljd\",\n \"email\": \"aditya.kohler@example.org\",\n \"first_name\": \"Aditya\",\n \"last_name\": \"Kohler\",\n \"company\": \"Gerlach, Ziemann and Reilly\",\n \"industry\": \"Nonprofit Organization Management\",\n \"website\": \"kunde.com\",\n \"title\": \"Ms.\",\n \"phone\": \"219-959-5166\",\n \"address\": \"41164 Osvaldo Row\",\n \"city\": \"Baileyborough\",\n \"state\": \"New Hampshire\",\n \"country\": \"US\",\n \"custom_merge_fields\": {\n \"fav color\": \"purple\",\n \"sport\": \"running\",\n \"os\": \"Windows NT 5.0\"\n },\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"OK\",\n \"interest\": null,\n \"emails_sent\": 0,\n \"completed_steps\": 0,\n \"is_missing_data\": 0,\n \"is_suppressed\": 0,\n \"created_at\": 1579888600,\n \"campaign\": {\n \"id\": \"fkjtf4390kfgu8903nsk\",\n \"name\": \"Grady-Runolfsson 16\",\n \"timezone\": \"US\\\/Mountain\",\n \"status\": \"DRAFT\",\n \"created_at\": 1579888600,\n \"client\": {\n \"id\": \"a83445df46as5432mga\",\n \"name\": \"Grady-Runolfsson\",\n \"created_at\": 1579888600\n }\n }\n }\n\t]\n}", "name": "" } ] }, { "name": "List contact activities", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contact-activities", "query": [ { "key": "activity", "value": "REPLIED", "description": "Filter by a specific activity. One of: BOUNCED, REPLIED, AUTOREPLIED, UNSUBSCRIBED. If omitted, returns all.", "disabled": false }, { "key": "from", "value": "2026-04-01T00%3A00%3A00Z", "description": "Start of date-time period (ISO 8601). Defaults to 24 hours ago.", "disabled": false }, { "key": "to", "value": "2026-04-02T00%3A00%3A00Z", "description": "End of date-time period (ISO 8601). Defaults to now.", "disabled": false }, { "key": "campaign_id", "value": "fkjtf4390kfgu8903nsk", "description": "The id of a campaign.", "disabled": false }, { "key": "client_id", "value": "a83445df46as5432mga", "description": "The id of a client.", "disabled": false }, { "key": "limit", "value": "50", "description": "The number of objects to return. Defaults to 100. Maximum 500.", "disabled": false }, { "key": "offset", "value": "0", "description": "The zero-based offset for pagination.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/contact-activities?activity=REPLIED&from=2026-04-01T00%3A00%3A00Z&to=2026-04-02T00%3A00%3A00Z&campaign_id=fkjtf4390kfgu8903nsk&client_id=a83445df46as5432mga&limit=50&offset=0" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return contacts that had a status change (bounced, replied, autoreplied, unsubscribed)\nwithin a given time period. Defaults to the last 24 hours." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"we52o4rv130mz1qxyzk8pmljd\",\n \"email\": \"aditya.kohler@example.org\",\n \"first_name\": \"Aditya\",\n \"last_name\": \"Kohler\",\n \"company\": \"Gerlach, Ziemann and Reilly\",\n \"status\": \"REPLIED\",\n \"interest\": null,\n \"activity\": \"REPLIED\",\n \"activity_date\": \"2026-03-15T17:52:47+00:00\",\n \"campaign_id\": \"x19qjz6gn6jlovy84r30\",\n \"campaign_name\": \"Test 1\"\n },\n {\n \"id\": \"j5ropgvndm6loe6z7lwe9481y\",\n \"email\": \"john.jacksom@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Jackson\",\n \"company\": null,\n \"status\": \"REPLIED\",\n \"interest\": \"POSITIVE\",\n \"activity\": \"REPLIED\",\n \"activity_date\": \"2026-03-11T14:03:39+00:00\",\n \"campaign_id\": \"o6djr143n5olm2y9kezv\",\n \"campaign_name\": \"Test 2\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Email Messages", "description": "\nAPIs for managing email messages.", "item": [ { "name": "Display a listing of a campaign's replies.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:campaign_id\/replies", "query": [ { "key": "limit", "value": "2", "description": "The number of objects to return. Defaults to 10. Maximum 20.", "disabled": false }, { "key": "offset", "value": "0", "description": "The zero-based offset for the default object sorting.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:campaign_id\/replies?limit=2&offset=0", "variable": [ { "id": "campaign_id", "key": "campaign_id", "value": "fkjtf4390kfgu8903nsk", "description": "The id of a campaign." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all email message replies of a campaign." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"2dpkq21yvjn4r530y56gzwlm3e08ox\",\n \"thread_id\": \"l12zpqxdn36mwrog08e5mwrkj\",\n \"contact_id\": \"83jm7zlgve0nlzq4d15orxywn\",\n \"from_email\": \"john.jacksom@example.com\",\n \"to_email\": \"corwin.velda@example.com\",\n \"from_name\": \"John Jackson\",\n \"to_name\": \"Corwin Velda\",\n \"submitted_at\": 1597066351,\n \"created_at\": 1597066376,\n \"subject\": \"Re: Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n },\n {\n \"id\": \"66lgem812pz0w7y6g9yoj3nr4kvqdx\",\n \"thread_id\": \"rdle34wnjy94qj6m178p0gz5v\",\n \"contact_id\": \"8j5orm17lnqgpkqvg9pk4z3ew\",\n \"from_email\": \"ella.jones@example.com\",\n \"to_email\": \"corwin.velda@example.com\",\n \"from_name\": \"Ella Jones\",\n \"to_name\": \"Corwin Velda\",\n \"submitted_at\": 1597066351,\n \"created_at\": 1597066376,\n \"subject\": \"Re: Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n }\n ]\n}", "name": "" } ] }, { "name": "Display a listing of a contact's replies.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/replies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/replies", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "83jm7zlgve0nlzq4d15orxywn", "description": "The id of a contact." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all email message replies of a contact." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"2dpkq21yvjn4r530y56gzwlm3e08ox\",\n \"thread_id\": \"l12zpqxdn36mwrog08e5mwrkj\",\n \"contact_id\": \"83jm7zlgve0nlzq4d15orxywn\",\n \"from_email\": \"john.jacksom@example.com\",\n \"to_email\": \"corwin.velda@example.com\",\n \"from_name\": \"John Jackson\",\n \"to_name\": \"Corwin Velda\",\n \"submitted_at\": 1597066351,\n \"created_at\": 1597066376,\n \"subject\": \"Re: Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n },\n {\n \"id\": \"rgr8yd4lkzvp05dw29nxe1w62m3qoj\",\n \"thread_id\": \"l12zpqxdn36mwrog08e5mwrkj\",\n \"contact_id\": \"83jm7zlgve0nlzq4d15orxywn\",\n \"from_email\": \"john.jacksom@example.com\",\n \"to_email\": \"corwin.velda@example.com\",\n \"from_name\": \"John Jackson\",\n \"to_name\": \"Corwin Velda\",\n \"submitted_at\": 1597066499,\n \"created_at\": 1597066528,\n \"subject\": \"Re: Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n }\n ]\n}", "name": "" } ] }, { "name": "Display an email thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-threads\/:email_thread_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-threads\/:email_thread_id", "variable": [ { "id": "email_thread_id", "key": "email_thread_id", "value": "rdle34wnjy94qj6m178p0gz5v", "description": "The id of the email thread." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return an email thread with all its messages." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": \"rdle34wnjy94qj6m178p0gz5v\",\n \"campaign_id\": \"jxv8qkeml4ml1g69y3w5\",\n \"contact_id\": \"8j5orm17lnqgpkqvg9pk4z3ew\",\n \"email_messages\": [\n {\n \"id\": \"2dpkq21yvjn4r530y56gzwlm3e08ox\",\n \"thread_id\": \"l12zpqxdn36mwrog08e5mwrkj\",\n \"contact_id\": \"83jm7zlgve0nlzq4d15orxywn\",\n \"from_email\": \"corwin.velda@example.com\",\n \"to_email\": \"ella.jones@example.com\",\n \"from_name\": \"Corwin Velda\",\n \"to_name\": \"Ella Jones\",\n \"submitted_at\": 1597066219,\n \"created_at\": 1597066208,\n \"subject\": \"Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n },\n {\n \"id\": \"66lgem812pz0w7y6g9yoj3nr4kvqdx\",\n \"thread_id\": \"rdle34wnjy94qj6m178p0gz5v\",\n \"contact_id\": \"8j5orm17lnqgpkqvg9pk4z3ew\",\n \"from_email\": \"ella.jones@example.com\",\n \"to_email\": \"corwin.velda@example.com\",\n \"from_name\": \"Ella Jones\",\n \"to_name\": \"Corwin Velda\",\n \"submitted_at\": 1597066351,\n \"created_at\": 1597066376,\n \"subject\": \"Re: Test message subject\",\n \"snippet\": \"Short Message Body...\",\n \"message_body\": \"Message body text...\",\n \"message_raw\": \"Raw Message text with html tags...\"\n }\n ]\n }\n}", "name": "" } ] } ] }, { "name": "Suppression", "description": "\nAPIs for managing suppression list.", "item": [ { "name": "Add new email address to suppression list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/suppressions\/emails", "query": [], "raw": "{{baseUrl}}\/api\/v1\/suppressions\/emails" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client_id\":\"a83445df46as5432mga\",\"emails\":[\"alicia.hammes@example.com\",\"douglas.herman@example.com\"]}" }, "description": "This will add new email addresses to a client's suppression list.\nAny contacts matching these emails, will be set as unsubscribed." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": [\n \"alicia.hammes@example.com\",\n \"douglas.herman@example.com\"\n ]\n}", "name": "" } ] }, { "name": "Add new domain address to suppression list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/suppressions\/domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/suppressions\/domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client_id\":\"a83445df46as5432mga\",\"domains\":[\"domain1.com\",\"domain2.com\"]}" }, "description": "This will add new domains to a client's suppression list.\nAny contacts matching these domains, will be set as unsubscribed." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": [\n \"domain1.com\",\n \"domain2.com\"\n ]\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }