{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.301.pro" } ], "info": { "name": "301.pro API Documentation", "_postman_id": "3c2aed3c-cd03-436b-9d19-f2c111c90809", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Teams", "description": "", "item": [ { "name": "Retrieve a list of teams available for the authenticated token.", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/teams", "query": [ { "key": "filter%5Bid%5D", "value": "000de240-04fe-40dd-8928-a94f61040035", "description": "UUID of the Team.", "disabled": false }, { "key": "filter%5Bname%5D", "value": "", "description": "Name of the Team. Partial Search. Wildcards are not needed.", "disabled": true }, { "key": "filter%5BteamType%5D", "value": "", "description": "Team Subscription Plan.", "disabled": true }, { "key": "filter%5BcreatedBy%5D", "value": "", "description": "ID of the user that created the Team.", "disabled": true }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Date of creation. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3C2025-04-01", "description": "Date of last update. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "include", "value": "domains%2Clabels", "description": "Comma separated list of relationships to include - Allowed relationships include domains, campaigns, pixels and labels.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/teams?filter%5Bid%5D=000de240-04fe-40dd-8928-a94f61040035&filter%5Bname%5D=&filter%5BteamType%5D=&filter%5BcreatedBy%5D=&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3C2025-04-01&include=domains%2Clabels" }, "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 {\n \"id\": \"000de240-04fe-40dd-8928-a94f61040035\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Business Demo\",\n \"teamType\": \"business_demo\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:34:50.000000Z\",\n \"updatedAt\": \"2025-09-29T18:35:25.000000Z\"\n },\n {\n \"id\": \"000de240-e3d4-464e-9f7a-b160235a1f05\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Artist\",\n \"teamType\": \"artist\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:34:45.000000Z\",\n \"updatedAt\": \"2025-09-29T18:35:21.000000Z\"\n },\n {\n \"id\": \"000de240-e4b3-4177-946f-c78813737cb3\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Professional\",\n \"teamType\": \"professional\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:34:41.000000Z\",\n \"updatedAt\": \"2025-09-29T18:35:16.000000Z\"\n },\n {\n \"id\": \"000de240-990b-4a6b-be68-b0c178b11949\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Business\",\n \"teamType\": \"business\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:34:36.000000Z\",\n \"updatedAt\": \"2025-09-29T18:35:11.000000Z\"\n },\n {\n \"id\": \"000de240-2e36-4621-a3fb-782db631e683\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Realtime\",\n \"teamType\": \"realtime\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:34:31.000000Z\",\n \"updatedAt\": \"2025-09-29T18:35:06.000000Z\"\n },\n {\n \"id\": \"9ffee0a0-99cf-48e6-9abb-1050d01e3493\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Scribe's Team\",\n \"teamType\": \"business_demo\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:26:31.000000Z\",\n \"updatedAt\": \"2025-09-29T18:26:35.000000Z\"\n },\n {\n \"id\": \"9ffedf1c-dbbe-4044-9632-877c56811cff\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Scribe's Team\",\n \"teamType\": \"business_demo\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:22:17.000000Z\",\n \"updatedAt\": \"2025-09-29T18:22:22.000000Z\"\n },\n {\n \"id\": \"9ffedd8d-eb0f-49d3-b7b3-9362241fb0aa\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Scribe's Team\",\n \"teamType\": \"business_demo\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:17:55.000000Z\",\n \"updatedAt\": \"2025-09-29T18:17:59.000000Z\"\n },\n {\n \"id\": \"9ffedd53-b9c9-4bb5-a150-7097338974e4\",\n \"teamOwnerId\": \"000de240-355e-4814-8606-d308260927ae\",\n \"name\": \"Scribe's Team\",\n \"teamType\": \"business_demo\",\n \"status\": \"published\",\n \"createdAt\": \"2025-09-29T18:17:17.000000Z\",\n \"updatedAt\": \"2025-09-29T18:17:21.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/teams?page=1\",\n \"last\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/teams?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/teams?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/teams\",\n \"per_page\": 15,\n \"to\": 9,\n \"total\": 9\n }\n}", "name": "" } ] } ] }, { "name": "Team", "description": "", "item": [ { "name": "Team Labels", "description": "", "item": [ { "name": "Retrieve a list of Team Labels", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/labels", "query": [ { "key": "filter%5Btitle%5D", "value": "%22Email%22", "description": "Label Title. Will return any Labels where Title contains the provided value. Wildcards are not needed.", "disabled": false }, { "key": "filter%5Bcolor%5D", "value": "%22%2300eeff%22", "description": "Label Color. Will return any Labels that include the provided color. Wildcards are not needed.", "disabled": false }, { "key": "filter%5Bdescription%5D", "value": "%22email%22", "description": "Label Description. Will return any Labels that where Description contains the provided value. Wildcards are not needed.", "disabled": false }, { "key": "filter%5BcreatedBy%5D", "value": "", "description": "ID of the user that created the Label.", "disabled": true }, { "key": "filter%5BupdatedBy%5D", "value": "", "description": "ID of the use that last updated the Label.", "disabled": true }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Date the Label was created. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3E2025-01-01", "description": "Date the Label was updated. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "sort", "value": "-createdAt%2Ctitle", "description": "Will Sort the results by title, color, createdAt, or updatedAt. Comma seperated. Prefix with - to sort descending.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/labels?filter%5Btitle%5D=%22Email%22&filter%5Bcolor%5D=%22%2300eeff%22&filter%5Bdescription%5D=%22email%22&filter%5BcreatedBy%5D=&filter%5BupdatedBy%5D=&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3E2025-01-01&sort=-createdAt%2Ctitle", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Team Labels are used to categorize ProLinks and Campaigns." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"000de240-327b-4696-9ce6-1ce91a4f2acb\",\n \"title\": \"Email\",\n \"color\": null,\n \"description\": \"0\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-d496-4d83-a42b-2eae485eeff9\",\n \"title\": \"Social\",\n \"color\": null,\n \"description\": \"1\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-439e-4664-ad11-76d83bccd90e\",\n \"title\": \"Announcement\",\n \"color\": null,\n \"description\": \"2\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-3a27-4fd2-9e9c-0d6bbbe9d906\",\n \"title\": \"Documentation\",\n \"color\": null,\n \"description\": \"3\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-7c52-41d9-b9c5-dcbadcae9e93\",\n \"title\": \"Demo\",\n \"color\": null,\n \"description\": \"4\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-d5c2-4212-9703-c5459bbea393\",\n \"title\": \"Event\",\n \"color\": null,\n \"description\": \"5\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n },\n {\n \"id\": \"000de240-4f14-4be8-b243-26a78f218bb4\",\n \"title\": \"Affiliate\",\n \"color\": null,\n \"description\": \"Affiliate Marketing\",\n \"createdAt\": \"2025-09-29T18:34:53.000000Z\",\n \"updatedAt\": \"2025-09-29T18:34:53.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/team\\\/000de240-2e36-4621-a3fb-782db631e683\\\/labels?page=1\",\n \"last\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/team\\\/000de240-2e36-4621-a3fb-782db631e683\\\/labels?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/team\\\/000de240-2e36-4621-a3fb-782db631e683\\\/labels?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https\\\\\\\/https:\/\/api.301.pro\\\/v1\\\/team\\\/000de240-2e36-4621-a3fb-782db631e683\\\/labels\",\n \"per_page\": 30,\n \"to\": 7,\n \"total\": 7\n }\n}", "name": "" } ] }, { "name": "Create a Team Label", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/labels", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/labels", "variable": [ { "id": "team_id", "key": "team_id", "value": "edab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Documentation\",\"color\":\"#fbf323\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-327b-4696-9ce6-1ce91a4f2acb\",\"title\":\"Email\",\"color\":null,\"description\":\"0\",\"createdAt\":\"2025-09-29T18:34:53.000000Z\",\"updatedAt\":\"2025-09-29T18:34:53.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Retrieve a Team Label", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/labels\/:id", "query": [ { "key": "include", "value": "include%3Dassignments", "description": "Retrieve relationships. Allowed relationships: assignments - include label assignment relationships.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/labels\/:id?include=include%3Dassignments", "variable": [ { "id": "team_id", "key": "team_id", "value": "e5ab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "c6ab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the Label." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-327b-4696-9ce6-1ce91a4f2acb\",\"title\":\"Email\",\"color\":null,\"description\":\"0\",\"createdAt\":\"2025-09-29T18:34:53.000000Z\",\"updatedAt\":\"2025-09-29T18:34:53.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Update a Team Label", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/labels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/labels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "edab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "c6ab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the Label." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Documentation\",\"color\":\"#fbf323\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-327b-4696-9ce6-1ce91a4f2acb\",\"title\":\"Email\",\"color\":null,\"description\":\"0\",\"createdAt\":\"2025-09-29T18:34:53.000000Z\",\"updatedAt\":\"2025-09-29T18:34:53.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Delete a Team Label", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/labels\/:id", "query": [ { "key": "force", "value": "true", "description": "must equal \"true\" exactly to Remove label and all of its assignments (force=true).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/labels\/:id?force=true", "variable": [ { "id": "team_id", "key": "team_id", "value": "edab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "c6ab8065-3013-433a-84a4-e81a5ca6c949", "description": "The ID of the Label." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a team label and optionally all label assignments" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Team Pixels", "description": "", "item": [ { "name": "Retrieve a list of Team Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/pixels", "query": [ { "key": "filter%5BpixelType%5D", "value": "FacebookPixel", "description": "Pixel Type", "disabled": false }, { "key": "filter%5BpixelTrackingId%5D", "value": "", "description": "Pixel Tracking Id", "disabled": true }, { "key": "filter%5BcreatedBy%5D", "value": "", "description": "ID of the user that created the Team Pixel.", "disabled": true }, { "key": "filter%5BupdatedBy%5D", "value": "", "description": "ID of the user that recently the Team Pixel.", "disabled": true }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Filter by date of creation Team Pixel. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3C2025-06-01", "description": "Filter by last updated date Team Pixel. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/pixels?filter%5BpixelType%5D=FacebookPixel&filter%5BpixelTrackingId%5D=&filter%5BcreatedBy%5D=&filter%5BupdatedBy%5D=&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3C2025-06-01", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "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 {\n \"id\": \"9e5c7b08-b278-4450-9bb3-2f4537518919\",\n \"subjectType\": \"team\",\n \"subjectId\": \"9e522e02-f1c7-4c1e-ba56-bafdfa930a69\",\n \"pixelType\": \"FacebookPixel\",\n \"pixelTypeDisplay\": \"Facebook Pixel\",\n \"pixelTrackingId\": \"5884321354687987\",\n \"description\": \"Team Facebook Pixel\",\n \"createdAt\": \"2025-03-05T18:46:23.000000Z\",\n \"updatedAt\": \"2025-03-05T18:46:23.000000Z\",\n \"createdBy\": \"9e522e02-f0fb-494f-976b-c10ccb498a8b\",\n \"updatedBy\": \"9e522e02-f0fb-494f-976b-c10ccb498a8b\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/api.301.pro\/v1\/team\/9e522e02-f1c7-4c1e-ba56-bafdfa930a69\/pixels?page=1\",\n \"last\": \"https:\/\/api.301.pro\/v1\/team\/9e522e02-f1c7-4c1e-ba56-bafdfa930a69\/pixels?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https:\/\/api.301.pro\/v1\/team\/9e522e02-f1c7-4c1e-ba56-bafdfa930a69\/pixels?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https:\/\/api.301.pro\/v1\/team\/9e522e02-f1c7-4c1e-ba56-bafdfa930a69\/pixels\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n}\n", "name": "" } ] }, { "name": "Create Team Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/pixels", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/pixels", "variable": [ { "id": "team_id", "key": "team_id", "value": "fdab26be-3e93-429f-94ac-3fe3f92aa9e6", "description": "The uuid of the team" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pixelType\":\"FacebookPixel\",\"pixelTrackingId\":\"282987392888293\"}" }, "description": "Create a new Team Pixel." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Retrieve a Team Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/pixels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/pixels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "000de240-676e-467e-988e-c10067cc36e3", "description": "The ID of the pixel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Update Team Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/pixels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/pixels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "72367d54-bc04-4103-85cb-3e2b3d586289", "description": "The uuid of the team" }, { "id": "id", "key": "id", "value": "44c7f967-b03b-467e-b8e7-fb934ff451f7", "description": "The uuid of the Team Pixel" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pixelType\":null,\"pixelTrackingId\":null}" }, "description": "Update an existing Team Pixel." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Permanently Delete Team Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/pixels\/:pixel_id\/force", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/pixels\/:pixel_id\/force", "variable": [ { "id": "team_id", "key": "team_id", "value": "036a5473-f481-4630-8d5b-3fc405badeaf", "description": "The uuid of the team" }, { "id": "pixel_id", "key": "pixel_id", "value": "8a8cfd8d-fa16-4ef7-ac9d-5eb0b9bfa8c9", "description": "The uuid of the Team Pixel" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete a Team Pixel" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] } ] }, { "name": "ProLinks", "description": "", "item": [ { "name": "Retrieve a list of ProLinks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks", "query": [ { "key": "filter%5Bstatus%5D", "value": "published", "description": "Filter by the status of the ProLink. Defaults To published when not provided.", "disabled": false }, { "key": "filter%5BcampaignId%5D", "value": "", "description": "Filter by Campaign ID.", "disabled": true }, { "key": "filter%5BdomainId%5D", "value": "", "description": "Filter by Domain ID.", "disabled": true }, { "key": "filter%5BcreatedBy%5D", "value": "", "description": "Filter by the user that created the ProLink.", "disabled": true }, { "key": "filter%5BupdatedBy%5D", "value": "", "description": "Filter by the user that last updated the ProLink.", "disabled": true }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Filter by Date the ProLink was created. You can filter for a specific date or before\/after a certain date by prefixing with >", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3C2025-03-01", "description": "Filter by Date the ProLink was updated. You can filter for a specific date or before\/after a certain date by prefixing with >", "disabled": false }, { "key": "filter%5BurlKey%5D", "value": "", "description": "Filter by the \"back half\". Partial search, wildcards are not needed.", "disabled": true }, { "key": "filter%5BdestinationUrl%5D", "value": "", "description": "Filter by the default destination url of the ProLink. Partial search, wildcards are not needed.", "disabled": true }, { "key": "filter%5Bdescription%5D", "value": "", "description": "Filter by the description of the ProLink. Partial search, wildcards are not needed.", "disabled": true }, { "key": "filter%5Btitle%5D", "value": "", "description": "Filter by the title of the destination page. Partial search, wildcards are not needed.", "disabled": true }, { "key": "sort", "value": "-updatedAt%2CurlKey", "description": "Sort the results by urlKey, createdAt, or updatedAt. Prefix with - to sort descending.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks?filter%5Bstatus%5D=published&filter%5BcampaignId%5D=&filter%5BdomainId%5D=&filter%5BcreatedBy%5D=&filter%5BupdatedBy%5D=&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3C2025-03-01&filter%5BurlKey%5D=&filter%5BdestinationUrl%5D=&filter%5Bdescription%5D=&filter%5Btitle%5D=&sort=-updatedAt%2CurlKey", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns ProLinks for the specified team. ProLinks can be filtered and ordered." }, "response": [] }, { "name": "Create a ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"example.com\",\"urlKey\":\"my-key\",\"destinationUrl\":\"https:\\\/\\\/example.com\\\/destination\",\"title\":\"About Us\",\"description\":\"This is a description for the About Us section\",\"campaignId\":\"568afe18-1f03-4263-9ef6-c3054b6856bf\",\"customData\":{\"hubspotCampaignId\":\"e5d960a2-8386-4884-a021-ac84d81eacd9\",\"customKey2\":\"customValue2\"}}" }, "description": "Creates a new ProLink for the specified team. A domain host must be provided." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-ef2b-4e41-a931-182320360306\",\"teamId\":\"000de240-2e36-4621-a3fb-782db631e683\",\"campaignId\":\"000de240-ecd8-4234-be2b-1f5415d4db7c\",\"apiHash\":\"rfhjb5QBNgc37HuwFdEyDC4J8MnipT\",\"urlKey\":\"8UxRT\",\"destinationUrl\":\"https:\\\/\\\/301pro.com\\\/solutions\",\"domainId\":\"9ed5ce3a-7698-46f4-9fc3-83d18b9942d2\",\"domainHost\":\"demo.301.pro\",\"status\":\"published\",\"title\":\"301.Pro Link Manager\",\"description\":\"301.Pro - Enterprise Link Management\",\"destinationMetaName\":{\"author\":\"301Pro\",\"viewport\":\"width=device-width, initial-scale=1.0\",\"description\":\"301.Pro - Enterprise Link Management\",\"twitter:card\":\"summary_large_image\",\"twitter:site\":\"@301pro\",\"twitter:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"twitter:title\":\"301Pro - Enterprise Link Management\",\"twitter:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"destinationMetaProperty\":{\"og:type\":\"website\",\"og:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"og:title\":\"301Pro - Enterprise Link Management\",\"og:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"customData\":null,\"clicks\":0,\"createdAt\":\"2025-09-29T18:34:55.000000Z\",\"updatedAt\":\"2025-10-01T17:54:06.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"id\": \"000de240-2e36-4621-a3fb-782db631e683\",\n \"teamId\": \"9ec2a283-2874-4b0f-9591-f5da40240398\",\n \"campaignId\": \"568afe18-1f03-4263-9ef6-c3054b6856bf\",\n \"apiHash\": \"vajhiQyANx4VF2wXnRqCcB7W5TDgbU\",\n \"urlKey\": \"my-key\",\n \"destinationUrl\": \"https:\/\/example.com\/destination\",\n \"domainId\": \"9ec2a27e-00d1-44db-9dde-0c7641a8a7bf\",\n \"domainHost\": \"example.com\",\n \"status\": \"published\",\n \"title\": \"About Us\",\n \"description\": \"This is a description for the About Us section\",\n \"destinationMetaName\": [],\n \"destinationMetaProperty\": [],\n \"customData\": {\n \"hubspotCampaignId\": \"e5d960a2-8386-4884-a021-ac84d81eacd9\",\n \"customKey2\": \"customValue2\"\n },\n \"clicks\": 0,\n \"createdAt\": \"2025-04-27T04:26:38.000000Z\",\n \"updatedAt\": \"2025-04-29T01:40:15.000000Z\",\n \"createdBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\",\n \"updatedBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\"\n}\n", "name": "" } ] }, { "name": "Retrieve a ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "000de240-ef2b-4e41-a931-182320360306", "description": "The ID of the prolink." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-ef2b-4e41-a931-182320360306\",\"teamId\":\"000de240-2e36-4621-a3fb-782db631e683\",\"campaignId\":\"000de240-ecd8-4234-be2b-1f5415d4db7c\",\"apiHash\":\"rfhjb5QBNgc37HuwFdEyDC4J8MnipT\",\"urlKey\":\"8UxRT\",\"destinationUrl\":\"https:\\\/\\\/301pro.com\\\/solutions\",\"domainId\":\"9ed5ce3a-7698-46f4-9fc3-83d18b9942d2\",\"domainHost\":\"demo.301.pro\",\"status\":\"published\",\"title\":\"301.Pro Link Manager\",\"description\":\"301.Pro - Enterprise Link Management\",\"destinationMetaName\":{\"author\":\"301Pro\",\"viewport\":\"width=device-width, initial-scale=1.0\",\"description\":\"301.Pro - Enterprise Link Management\",\"twitter:card\":\"summary_large_image\",\"twitter:site\":\"@301pro\",\"twitter:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"twitter:title\":\"301Pro - Enterprise Link Management\",\"twitter:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"destinationMetaProperty\":{\"og:type\":\"website\",\"og:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"og:title\":\"301Pro - Enterprise Link Management\",\"og:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"customData\":null,\"clicks\":0,\"createdAt\":\"2025-09-29T18:34:55.000000Z\",\"updatedAt\":\"2025-10-01T17:54:06.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"id\": \"000de240-2e36-4621-a3fb-782db631e683\",\n \"teamId\": \"9ec2a283-2874-4b0f-9591-f5da40240398\",\n \"campaignId\": \"568afe18-1f03-4263-9ef6-c3054b6856bf\",\n \"apiHash\": \"vajhiQyANx4VF2wXnRqCcB7W5TDgbU\",\n \"urlKey\": \"my-key\",\n \"destinationUrl\": \"https:\/\/example.com\/destination\",\n \"domainId\": \"9ec2a27e-00d1-44db-9dde-0c7641a8a7bf\",\n \"domainHost\": \"example.com\",\n \"status\": \"published\",\n \"title\": \"About Us\",\n \"description\": \"This is a description for the About Us section\",\n \"destinationMetaName\": [],\n \"destinationMetaProperty\": [],\n \"customData\": {\n \"hubspotCampaignId\": \"e5d960a2-8386-4884-a021-ac84d81eacd9\",\n \"customKey2\": \"customValue2\"\n },\n \"clicks\": 0,\n \"createdAt\": \"2025-04-27T04:26:38.000000Z\",\n \"updatedAt\": \"2025-04-29T01:40:15.000000Z\",\n \"createdBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\",\n \"updatedBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\"\n}\n", "name": "" } ] }, { "name": "Update a ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "000de240-ef2b-4e41-a931-182320360306", "description": "The ID of the prolink." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"example.com\",\"urlKey\":\"my-key\",\"destinationUrl\":\"https:\\\/\\\/example.com\\\/destination\",\"title\":\"About Us\",\"description\":\"This is a description for the About Us section\",\"campaignId\":\"568afe18-1f03-4263-9ef6-c3054b6856bf\",\"customData\":{\"hubspotCampaignId\":\"e5d960a2-8386-4884-a021-ac84d81eacd9\",\"customKey2\":\"customValue2\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"000de240-ef2b-4e41-a931-182320360306\",\"teamId\":\"000de240-2e36-4621-a3fb-782db631e683\",\"campaignId\":\"000de240-ecd8-4234-be2b-1f5415d4db7c\",\"apiHash\":\"rfhjb5QBNgc37HuwFdEyDC4J8MnipT\",\"urlKey\":\"8UxRT\",\"destinationUrl\":\"https:\\\/\\\/301pro.com\\\/solutions\",\"domainId\":\"9ed5ce3a-7698-46f4-9fc3-83d18b9942d2\",\"domainHost\":\"demo.301.pro\",\"status\":\"published\",\"title\":\"301.Pro Link Manager\",\"description\":\"301.Pro - Enterprise Link Management\",\"destinationMetaName\":{\"author\":\"301Pro\",\"viewport\":\"width=device-width, initial-scale=1.0\",\"description\":\"301.Pro - Enterprise Link Management\",\"twitter:card\":\"summary_large_image\",\"twitter:site\":\"@301pro\",\"twitter:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"twitter:title\":\"301Pro - Enterprise Link Management\",\"twitter:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"destinationMetaProperty\":{\"og:type\":\"website\",\"og:image\":\"https:\\\/\\\/www.301.Pro\\\/images\\\/app\\\/prolinks.jpg\",\"og:title\":\"301Pro - Enterprise Link Management\",\"og:description\":\"Premium advertising and marketing solutions for enterprise and agency logos\"},\"customData\":null,\"clicks\":0,\"createdAt\":\"2025-09-29T18:34:55.000000Z\",\"updatedAt\":\"2025-10-01T17:54:06.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"id\": \"000de240-2e36-4621-a3fb-782db631e683\",\n \"teamId\": \"9ec2a283-2874-4b0f-9591-f5da40240398\",\n \"campaignId\": \"568afe18-1f03-4263-9ef6-c3054b6856bf\",\n \"apiHash\": \"vajhiQyANx4VF2wXnRqCcB7W5TDgbU\",\n \"urlKey\": \"my-key\",\n \"destinationUrl\": \"https:\/\/example.com\/destination\",\n \"domainId\": \"9ec2a27e-00d1-44db-9dde-0c7641a8a7bf\",\n \"domainHost\": \"example.com\",\n \"status\": \"published\",\n \"title\": \"About Us\",\n \"description\": \"This is a description for the About Us section\",\n \"destinationMetaName\": [],\n \"destinationMetaProperty\": [],\n \"customData\": {\n \"hubspotCampaignId\": \"e5d960a2-8386-4884-a021-ac84d81eacd9\",\n \"customKey2\": \"customValue2\"\n },\n \"clicks\": 0,\n \"createdAt\": \"2025-04-27T04:26:38.000000Z\",\n \"updatedAt\": \"2025-04-29T01:40:15.000000Z\",\n \"createdBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\",\n \"updatedBy\": \"9ec2a283-2808-4c31-88ec-feb72578e089\"\n}\n", "name": "" } ] }, { "name": "Delete ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "000de240-ef2b-4e41-a931-182320360306", "description": "The ID of the prolink." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"status\": \"success\"}", "name": "" } ] }, { "name": "Batch Operations", "description": "", "item": [ { "name": "Batch Create ProLinks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team\/prolinks\/batch\/create", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team\/prolinks\/batch\/create", "variable": [ { "id": "team", "key": "team", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"proLinks\":[{\"domain\":\"example.com\",\"urlKey\":\"my-key\",\"destinationUrl\":\"https:\\\/\\\/example.com\\\/destination\",\"title\":\"About Us\",\"description\":\"This is a description for the About Us section\",\"campaignId\":\"568afe18-1f03-4263-9ef6-c3054b6856bf\",\"customData\":{\"hubspotCampaignId\":\"e5d960a2-8386-4884-a021-ac84d81eacd9\",\"customKey2\":\"customValue2\"}}]}" }, "description": "Creates new ProLinks for the specified team. A domain host must be provided for each ProLink." }, "response": [ { "header": [], "code": 200, "body": "{\n \"proLinks\": [\n {\n \"urlKey\": \"dnJseU8bn\",\n \"destinationUrl\": \"https:\/\/example.com\/destination\",\n \"teamDomainId\": \"a002db18-2d35-447e-8db7-dfefc665e90b\",\n \"domainId\": \"9ec2a27e-00d1-44db-9dde-0c7641a8a7bf\",\n \"domainHost\": \"example.com\",\n \"status\": \"draft\",\n \"title\": \"About Us\",\n \"description\": \"This is a description for the About Us section\",\n \"customData\": {\n \"hubspotCampaignId\": \"e5d960a2-8386-4884-a021-ac84d81eacd9\",\n \"customKey2\": \"customValue2\"\n },\n }\n ]\n}\n\n", "name": "" } ] } ] }, { "name": "Archive a collection of ProLinks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/archive", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/archive", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"f706b628-8412-4303-b4e1-74c197f1052d\",\"889dd662-d418-4c77-a2cd-78553553d6b8\",\"59b41355-9c68-473f-883c-0c950501c1da\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Remove archive status from a collection of ProLinks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/unarchive", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/unarchive", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"f706b628-8412-4303-b4e1-74c197f1052d\",\"889dd662-d418-4c77-a2cd-78553553d6b8\",\"59b41355-9c68-473f-883c-0c950501c1da\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "ProLink Labels", "description": "", "item": [ { "name": "Assign Labels", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/attach", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/attach", "variable": [ { "id": "team_id", "key": "team_id", "value": "b3f6222c-5e38-4357-b831-0a24a7886a03", "description": "The uuid of the team" }, { "id": "prolink_id", "key": "prolink_id", "value": "a6122210-e83a-4667-83ae-b7f05e3a2c47", "description": "The uuid of the ProLink" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "Assign labels to a ProLink." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Unassign Labels", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/detach", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/detach", "variable": [ { "id": "team_id", "key": "team_id", "value": "fd8ecc00-d0a1-4cbb-97af-68aa37db8c71", "description": "The uuid of the team" }, { "id": "prolink_id", "key": "prolink_id", "value": "ef8f3203-7d43-49af-a9b6-54ec3b9f09fb", "description": "The uuid of the ProLink" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "Remove label assignment from a ProLink." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Sync Labels", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/sync", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:prolink_id\/labels\/sync", "variable": [ { "id": "team_id", "key": "team_id", "value": "e1b37072-0b8e-4b5b-ae81-ff53dca8c726", "description": "The uuid of the team" }, { "id": "prolink_id", "key": "prolink_id", "value": "476d29f3-0656-4852-ad07-d59bd67973be", "description": "The uuid of the ProLink" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "Add or remove label assignments from a ProLink in a single request." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Permanently delete the specified ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:prolink_id\/force", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:prolink_id\/force", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "prolink_id", "key": "prolink_id", "value": "000de240-ef2b-4e41-a931-182320360306", "description": "The ID of the prolink." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Undelete a ProLink", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/prolinks\/:prolink_id\/restore", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/prolinks\/:prolink_id\/restore", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "prolink_id", "key": "prolink_id", "value": "000de240-ef2b-4e41-a931-182320360306", "description": "The ID of the prolink." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Campaigns", "description": "", "item": [ { "name": "Retrieve a list of Campaigns", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns", "query": [ { "key": "filter%5Bstatus%5D", "value": "archived", "description": "Filter by Status. Defaults To published when not provided.", "disabled": false }, { "key": "filter%5Bname%5D", "value": "%22Email%22", "description": "Filter by Campaign name. Wildcards are not needed.", "disabled": false }, { "key": "filter%5Bdescription%5D", "value": "%22customer%22", "description": "Filter by Campaign Description. Wildcards are not needed.", "disabled": false }, { "key": "filter%5BcreatedBy%5D", "value": "568afe18-1f03-4263-9ef6-c3054b6856bf", "description": "Filter by User ID that created the Campaign.", "disabled": false }, { "key": "filter%5BupdatedBy%5D", "value": "568afe18-1f03-4263-9ef6-c3054b6856bf", "description": "Filter by User ID that last updated the Campaign.", "disabled": false }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Filter by date the Campaign was created. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3C2025-06-01", "description": "Filter by date the Campaign was updated. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns?filter%5Bstatus%5D=archived&filter%5Bname%5D=%22Email%22&filter%5Bdescription%5D=%22customer%22&filter%5BcreatedBy%5D=568afe18-1f03-4263-9ef6-c3054b6856bf&filter%5BupdatedBy%5D=568afe18-1f03-4263-9ef6-c3054b6856bf&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3C2025-06-01", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Create a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"CDE - Click Data Enrichment\",\"description\":\"Add Click Data Enrichment (CDE) to each link\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"a002dac1-1665-462e-822a-46b137e657ac\",\"teamId\":\"9ed5d488-9940-4840-b979-617e080d8be9\",\"name\":\"CDE - Click Data Enrichment\",\"description\":\"Add Click Data Enrichment (CDE) to each link\",\"status\":\"published\",\"createdAt\":\"2025-10-01T17:53:24.000000Z\",\"updatedAt\":\"2025-10-01T17:53:27.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Retrieve a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "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": "{\"id\":\"a002dac1-1665-462e-822a-46b137e657ac\",\"teamId\":\"9ed5d488-9940-4840-b979-617e080d8be9\",\"name\":\"CDE - Click Data Enrichment\",\"description\":\"Add Click Data Enrichment (CDE) to each link\",\"status\":\"published\",\"createdAt\":\"2025-10-01T17:53:24.000000Z\",\"updatedAt\":\"2025-10-01T17:53:27.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Update a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Email Campaign\",\"description\":\"Followup technical support email's\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"a002dac1-1665-462e-822a-46b137e657ac\",\"teamId\":\"9ed5d488-9940-4840-b979-617e080d8be9\",\"name\":\"CDE - Click Data Enrichment\",\"description\":\"Add Click Data Enrichment (CDE) to each link\",\"status\":\"published\",\"createdAt\":\"2025-10-01T17:53:24.000000Z\",\"updatedAt\":\"2025-10-01T17:53:27.000000Z\"}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Delete a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "id", "key": "id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Campaign Pixels", "description": "", "item": [ { "name": "Retrieve a list of Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels", "query": [ { "key": "filter%5BpixelType%5D", "value": "FacebookPixel", "description": "Pixel Type", "disabled": false }, { "key": "filter%5BpixelTrackingId%5D", "value": "", "description": "Pixel Tracking Id", "disabled": true }, { "key": "filter%5BcreatedBy%5D", "value": "", "description": "ID of the user that created the Campaign Pixel.", "disabled": true }, { "key": "filter%5BupdatedBy%5D", "value": "", "description": "ID of the user that recently the Campaign Pixel.", "disabled": true }, { "key": "filter%5BcreatedAt%5D", "value": "%3E2025-01-01", "description": "Filter by date of creation Campaign Pixel. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false }, { "key": "filter%5BupdatedAt%5D", "value": "%3C2025-06-01", "description": "Filter by last updated date Campaign Pixel. You can filter for a specific date or before\/after a certain date by prefixing with > or ", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels?filter%5BpixelType%5D=FacebookPixel&filter%5BpixelTrackingId%5D=&filter%5BcreatedBy%5D=&filter%5BupdatedBy%5D=&filter%5BcreatedAt%5D=%3E2025-01-01&filter%5BupdatedAt%5D=%3C2025-06-01", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "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 \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Create Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels", "variable": [ { "id": "team_id", "key": "team_id", "value": "508f07a8-c037-4da3-965a-ee0e7155c5fc", "description": "The uuid of the team" }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pixelType\":\"FacebookPixel\",\"pixelTrackingId\":\"282987392888293\"}" }, "description": "Create a new Campaign Pixel." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Retrieve a Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." }, { "id": "id", "key": "id", "value": "000de240-676e-467e-988e-c10067cc36e3", "description": "The ID of the pixel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Update Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "fe4cd64e-b06c-4941-8ccd-92746be6776c", "description": "The uuid of the team" }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." }, { "id": "id", "key": "id", "value": "53a94ee2-dad6-4f12-b795-c337e57741b2", "description": "The uuid of the Campaign Pixel" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pixelType\":null,\"pixelTrackingId\":null}" }, "description": "Update an existing Campaign Pixel." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"error\",\n \"message\": \"Access Denied\"\n}", "name": "" } ] }, { "name": "Delete a Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:id", "variable": [ { "id": "team_id", "key": "team_id", "value": "138f1956-082e-4899-9421-06bbc95ae478", "description": "The uuid of the team" }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." }, { "id": "id", "key": "id", "value": "b9202187-499e-44d1-b807-546dd3baf159", "description": "The uuid of the Campaign Pixel" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a Campaign Pixel." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Permanently Delete Campaign Pixel ", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:pixel_id\/force", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/pixels\/:pixel_id\/force", "variable": [ { "id": "team_id", "key": "team_id", "value": "02965368-dc4c-4c97-96cc-5cde287569da", "description": "The uuid of the team" }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." }, { "id": "pixel_id", "key": "pixel_id", "value": "d6683156-e48b-448b-acf8-41f981dbcc6a", "description": "The uuid of the Campaign Pixel" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete a Campaign Pixel" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Campaign Labels", "description": "", "item": [ { "name": "Assign labels to a Campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/attach", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/attach", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Remove label assignment from a Campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/detach", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/detach", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Add or remove label assignments from a Campaign in a single request.", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/sync", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/labels\/sync", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ids\":[\"9e545a7c-864e-41f4-8f9a-6eeba429f35d\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Permanently delete a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/force", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/force", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] }, { "name": "Undelete a Campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/campaigns\/:campaign_id\/restore", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/campaigns\/:campaign_id\/restore", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." }, { "id": "campaign_id", "key": "campaign_id", "value": "a002dac1-1665-462e-822a-46b137e657ac", "description": "The ID of the campaign." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\"\n}\n", "name": "" } ] } ] }, { "name": "Utilities", "description": "", "item": [ { "name": "Encode Customer Numbers", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/team\/:team_id\/utils\/customer-id-encode", "query": [], "raw": "{{baseUrl}}\/v1\/team\/:team_id\/utils\/customer-id-encode", "variable": [ { "id": "team_id", "key": "team_id", "value": "9ffef0a7-e8a8-4d1b-98d1-fb819a02ded0", "description": "The ID of the team." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customerNumbers\":[\"555-555-4567\",\"(555) 555-7894\"]}" }, "description": "This endpoint is designed to handle the encoding and sanitization of customer IDs within a specific team context. It accepts an array of customer IDs and processes each ID to generate a sanitized version and an encoded version, returning these transformations in a structured format. Up to 1000 numbers can be encoded in each request." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"customerNumber\": \"555-555-4567\",\n \"sanitized\": \"5555554567\",\n \"encoded\": \"qBpEFZ\"\n },\n {\n \"customerNumber\": \"(555) 555-7894\",\n \"sanitized\": \"5555557894\",\n \"encoded\": \"qBpeRs\"\n }\n ]\n }\n\n", "name": "" } ] } ] }, { "name": "Webhook Events", "description": "Endpoints for handling webhook events from Prolink. Visit https:\/\/301.pro\/developer\/v1\/webhooks for more information", "item": [ { "name": "Click Events", "description": null, "item": [ { "name": "Prolink Click Event", "request": { "url": { "host": "{{baseUrl}}", "path": "\/your-defined-custom-domain-endpoint\/", "query": [], "raw": "{{baseUrl}}\/\/your-defined-custom-domain-endpoint\/" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint receives click events for Prolink URLs.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"event\":\"prolink.click\",\"version\":\"1.0.1\",\"docs\":\"https:\/\/app.301.pro\/developer\/v1\/webhooks\/prolink.click\",\"clickId\":\"afe5dbee-54a8-4662-837e-88f50b1acbc7\",\"data\":{\"proLink\":{\"apiHash\":\"N5nVFPJvzQuA4egfxyL6EMctYqBmXh\",\"id\":\"9d725436-19d9-4320-b8b7-6ccf0d60f104\",\"teamId\":\"9d71a317-0320-4d96-affc-580457cee454\",\"campaignId\":\"012e7f75-e6f0-477f-a71b-4c2044cf3765\",\"url\":\"https:\/\/301.pro\/meeting\/abcdef\",\"destination\":\"https:\/\/hello.301.pro\/meetings\/301pro\/schedule\",\"host\":\"301.pro\",\"deepLink\":\"https:\/\/app.301.pro\/teams\/9d71a317-0320-4d96-affc-580457cee454\/pro-links\/9d725436-19d9-4320-b8b7-6ccf0d60f104\/show\",\"customData\":{\"hubspotCampaignId\":\"e5d960a2-8386-4884-a021-ac84d81eacd9\",\"customKey2\":\"customValue2\"}},\"campaign\":{\"id\":\"012e7f75-e6f0-477f-a71b-4c2044cf3765\",\"name\":\"Campaign Name\",\"teamId\":\"9d71a317-0320-4d96-affc-580457cee454\"},\"click\":{\"ipAddress\":\"68.227.226.150\",\"utcDatetime\":\"2024-12-16T17:58:38.000Z\",\"utcEpoch\":1735689918,\"timezone\":\"America\/Phoenix\",\"variant\":\"abcdef\",\"variantDecoded\":\"6025551234\",\"datetime\":\"2024-12-16T10:58:38\",\"day\":\"Mon\",\"hour\":10,\"minute\":58,\"second\":38,\"botScore\":96,\"acceptLanguage\":\"en-US,en;q=0.9\",\"userAgent\":\"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/131.0.0.0 Safari\/537.36 Edg\/131.0.0.0\",\"latitude\":\"33.39810\",\"longitude\":\"-111.78500\",\"continent\":\"NA\",\"country\":\"US\",\"city\":\"Mesa\",\"region\":\"Arizona\",\"regionCode\":\"AZ\",\"postalCode\":\"85204\",\"referrerUrl\":\"https:\/\/x.pro\/userid\/tweetId\",\"destination\":\"https:\/\/hello.301.pro\/meetings\/301pro\/schedule\"}}}", "name": "Event received successfully." } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }