{ "info": { "_postman_id": "512695aa-9b55-4e6c-9300-417cc90bb43b", "name": "Email API collection", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "37198385", "_collection_link": "https://www.postman.com/zoho-emailapi-b1/zoho-campaigns-email-api/collection/lhb7bxz/email-api-collection?action=share&source=collection_link&creator=37198385" }, "item": [ { "name": "v1 - OAuth", "item": [ { "name": "Transmission", "item": [ { "name": "Send Email", "item": [ { "name": "A simple request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "A simple request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588002\"\n}" } ] }, { "name": "With Template ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"template_id\": \"1093639000412559078\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "With Template ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n \n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"template_id\": \"1093639000412559078\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:57:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588055\"\n}" } ] }, { "name": "With Recipient list ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"ea_test_1\",\n \"recipient_list_id\": \"1093639000000046001\",\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"EA test 1\",\n \"html\": \"Welcome $[first_name|Customer]$, your content here $[first_name|Customer]$\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "With Recipient list ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"campaign_name\": \"ea_test_1\",\n \"recipient_list_id\": \"1093639000000046001\",\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"EA test 1\",\n \"html\": \"Welcome $[first_name|Customer]$, your content here $[first_name|Customer]$\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 5,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With schedule option", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"schedule_at\": 1728474636000\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "With schedule option", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"schedule_at\": 1728474636000\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With tracking disabled", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "With tracking disabled", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"open_tracking\": \"disabled\",\n \"click_tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With unsubscribe link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here

Unsubscribe\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission" ] } }, "response": [ { "name": "With unsubscribe link", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here

Unsubscribe\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] }, { "name": "Get transmission details", "item": [ { "name": "Get transmission details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Get transmission details", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:57:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"transmission_details\": {\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"from\": \"aron.ea@zylker.com\",\n \"transmission_name\": \"My first Email API Campaign\",\n \"status\": \"Reviewed\",\n \"sent_time\": 1728472166000,\n \"options\": {\n \"open_tracking\": \"disabled\",\n \"click_tracking\": \"disabled\"\n }\n },\n \"response\": {\n \"code\": 200004,\n \"message\": \"Successfully obtained the transmission details\"\n }\n}" } ] } ] }, { "name": "Reschedule transmission", "item": [ { "name": "Reschedule transmission", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"schedule_at\": 1728472166000\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Reschedule transmission", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"schedule_at\": 1728472166000\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] }, { "name": "Cancel transmission", "item": [ { "name": "Cancel transmission", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Cancel transmission", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200003,\n \"message\": \"Scheduled transmission has been successfully canceled\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] } ] }, { "name": "Domain Settings", "item": [ { "name": "Sending and Bounce Domains", "item": [ { "name": "Add a domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "response": [ { "name": "Add a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"send1.zylker.in\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"send1.zylker.in\",\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"141510._domainkey.send1.zylker.in\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDbGG0RcWh6uIinKlVpSVNG2LWMHbITApd9K4sIHq5Dz71HO1jUCfkAGHQEyjMn6K1GrHOMclLVMa8+cMryIJbX8gOciP9gOXKtw1ib+YAdQl0fXjQgpOdf8CnWhT2uvfAy/2TUY9BBFBIll5R7+iL1omjGZ6hlAUZbC1Nu07qIVQIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"bounce.send1.zylker.in\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"74665059.sender1.localcampaign1.com\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Add a domain with bounce domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\",\n \"bounce_domain\": \"custom-bounce.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "response": [ { "name": "Add a domain with custom bounce domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\",\n \"bounce_domain\": \"custom-bounce.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"zylker.com\",\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"141510._domainkey.zylker.com\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDbGG0RcWh6uIinKlVpSVNG2LWMHbITApd9K4sIHq5Dz71HO1jUCfkAGHQEyjMn6K1GrHOMclLVMa8+cMryIJbX8gOciP9gOXKtw1ib+YAdQl0fXjQgpOdf8CnWhT2uvfAy/2TUY9BBFBIll5R7+iL1omjGZ6hlAUZbC1Nu07qIVQIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"custom-bounce.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"74665059.sender.campaign.com\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Get the list of domains", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "response": [ { "name": "Get the list of domains", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:35:23 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "346" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200101,\n \"message\": \"Successfully obtained the list of configured domains\"\n },\n \"domains\": [\n {\n \"domain_name\": \"zylker.com\",\n \"is_sending_domain_verified\": false,\n \"is_bounce_domain_verified\": false,\n \"is_verified\": false\n },\n {\n \"domain_name\": \"zylker2.com\",\n \"is_sending_domain_verified\": true,\n \"is_bounce_domain_verified\": true,\n \"is_verified\": true\n }\n ]\n}" } ] }, { "name": "Get single domain details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/emailapi.test.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "emailapi.test.com" ] } }, "response": [ { "name": "Get single domain details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/emailapi.test.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "emailapi.test.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 09:55:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"emailapi.test.com\",\n \"response\": {\n \"code\": 200105,\n \"message\": \"Successfully obtained the domain details\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"16255._domainkey.emailapi.test.com\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrRqJ3aUrglbLI30QkxsfFkohu/bqrNfPAsQpy0c0F1nLhbem9n9BawQQVE2f/qug0p26FaK1Be0rSAX1s7/9TB0tHuwBbTKNsGgvJmu41kRwnXAnfXs+rsQWThzW/L5/vUsJFF3Utb4U5ng6eQZ0KhRmIfDTk8wgS2blSabSbIwIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"bounce.emailapi.test.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"809553610.send.zcsend.net\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Verify a domain", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "verify" ] } }, "response": [ { "name": "Verify a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:20 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "132" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"verify_result\": {\n \"sending_domain\": true,\n \"bounce_domain\": true\n },\n \"response\": {\n \"code\": 200103,\n \"message\": \"Domain verification successful\"\n }\n}" } ] }, { "name": "Delete a domain", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "response": [ { "name": "Delete a domain", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.in\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:41:47 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "68" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200104,\n \"message\": \"Domain deleted successfully\"\n }\n}" } ] } ] }, { "name": "Tracking Domains", "item": [ { "name": "Add a domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/tracking", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking" ] } }, "response": [ { "name": "Add a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain/tracking", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"tracking_domain\": {\n \"dns_host_name\": \"track.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"campaigns.ca.zohohosts.com\",\n \"verify_status\": \"Unauthenticated\",\n \"is_default\": false\n }\n}" } ] }, { "name": "Get the list of domains", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/tracking", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking" ] } }, "response": [ { "name": "Get the list of domains", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain/tracking", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:35:23 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "346" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200101,\n \"message\": \"Successfully obtained the list of configured domains\"\n },\n \"domains\": [\n {\n \"verify_status\": \"Unauthenticated\",\n \"domain_name\": \"testing1.com\",\n \"added_time\": 1723188780000,\n \"is_default\": false\n },\n {\n \"verify_status\": \"Pending\",\n \"domain_name\": \"tracking.wakeupwith.in\",\n \"added_time\": 1725012968000,\n \"is_default\": false\n },\n {\n \"verify_status\": \"Authenticated\",\n \"domain_name\": \"track.zylker.com\",\n \"added_time\": 1726640934000,\n \"is_default\": true\n }\n ]\n}" } ] }, { "name": "Get single domain details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/tracking/track.zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking", "track.zylker.com" ] } }, "response": [ { "name": "Get single domain details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain/tracking/track.zylker.com", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking", "track.zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 09:55:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200105,\n \"message\": \"Successfully obtained the domain details\"\n },\n \"tracking_domain\": {\n \"dns_host_name\": \"track.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"campaigns.cs.zohohost.com\",\n \"verify_status\": \"Unauthenticated\",\n \"is_default\": false\n }\n}" } ] }, { "name": "Verify a domain", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "verify" ] } }, "response": [ { "name": "Verify a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:20 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "132" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"verify_result\": \"Pending\",\n \"response\": {\n \"code\": 200109,\n \"message\": \"Tracking domain verification is in progress\"\n }\n}" } ] }, { "name": "Mark a domain as default", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain/tracking/default", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking", "default" ] } }, "response": [ { "name": "Mark a domain as default", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain/tracking/default", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain", "tracking", "default" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200108,\n \"message\": \"Default tracking domain enabled successfully\"\n }\n}" } ] }, { "name": "Delete a domain", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "response": [ { "name": "Delete a domain", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/domain", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:41:47 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "68" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200106,\n \"message\": \"Tracking domain deleted successfully\"\n }\n}" } ] } ] } ] }, { "name": "Webhook Settings", "item": [ { "name": "Create a webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Create a webhook - no auth", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook - no auth", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Create a webhook - auth token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Auth Token\",\n \"auth_token\": \"authtoken\"\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook - auth token", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Auth Token\",\n \"auth_token\": \"authtoken\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Modify a webhook", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce new webhook 1\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\",\n \"webhook_actions\": [\n \"bounce\",\n \"spam\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook/214548000000287005", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook", "214548000000287005" ] } }, "response": [ { "name": "Modify a webhook", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce new webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/webhook/146429000000060005", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "webhook", "146429000000060005" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:45:45 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "210" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce new webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\"\n },\n \"response\": {\n \"code\": 200204,\n \"message\": \"Webhook edited successfully\"\n }\n}" } ] }, { "name": "Delete a webhook", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook/1093639000412560003", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook", "1093639000412560003" ] } }, "response": [ { "name": "Delete a webhook", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook/1093639000412560003", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook", "1093639000412560003" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:46:31 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "104" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook_id\": \"1093639000412560003\",\n \"response\": {\n \"code\": 200205,\n \"message\": \"Webhook deleted successfully\"\n }\n}" } ] }, { "name": "Get webhook details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook/214548000000069220", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook", "214548000000069220" ] } }, "response": [ { "name": "Get webhook details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/settings/webhook/146429000000060005", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "settings", "webhook", "146429000000060005" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:45:05 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "636" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"is_virtual\": false,\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"version\": 2,\n \"url\": \"https://zylker.com/bounceone\",\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"zylker\",\n },\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"field_list\": {\n \"146429000000000021\": \"contact_email\"\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n }\n },\n \"response\": {\n \"code\": 200202,\n \"message\": \"Successfully obtained the webhook details\"\n }\n}" } ] }, { "name": "Get all webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "response": [ { "name": "Get all webhooks", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:44:10 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "345" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"from_index\": 0,\n \"total_webhook_count\": 1,\n \"webhook_list\": [\n {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n }\n ],\n \"response\": {\n \"code\": 200201,\n \"message\": \"Successfully obtained the list of configured webhooks\"\n },\n \"limit\": 200\n}" } ] } ] }, { "name": "Reports", "item": [ { "name": "Events", "item": [ { "name": "Open report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/open?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "open" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Open report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/open?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "open" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Click report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/click?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "click" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Click report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/click?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "click" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"click_url\": \"https://zylker.com\",\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"click_url\": \"https://zylker.com\",\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Bounce report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/bounce?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "bounce" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Bounce report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/bounce?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "bounce" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"bounce_type\": \"hardbounce\",\n \"action_time\": 1733397337000,\n \"injected_time\": 1733426111000,\n \"bounce_dsn\": \"Permanent failure :bad-domain\",\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911231444832\"\n },\n \"transmission_id\": 1231400009461002,\n \"contact_id\": 512310009462015,\n \"transmission_name\": \"API CAMPAIGN IDC - 1\",\n \"zuid\": 12391,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Spam report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/spam?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "spam" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Spam report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/event/spam?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "event", "spam" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] } ] }, { "name": "Summary Report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/reports/delivery/summary?from=1710571707000&to=1721112520000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "reports", "delivery", "summary" ], "query": [ { "key": "from", "value": "1710571707000" }, { "key": "to", "value": "1721112520000" } ] } }, "response": [ { "name": "Summary Report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v1/reports/delivery/summary?from=1710571707000&to=1721112520000", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v1", "reports", "delivery", "summary" ], "query": [ { "key": "from", "value": "1710571707000" }, { "key": "to", "value": "1721112520000" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:48:46 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": {\n \"summary\": {\n \"total_sent_count\": 2611,\n \"total_delivered_count\": 2411,\n \"total_opened_count\": 50,\n \"total_click_count\": 45,\n \"total_bounce_count\": 20,\n \"total_spam_count\": 0\n },\n \"stats\": [\n {\n \"spam_count\": 0,\n \"delivered_count\": 6,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 6,\n \"timestamp\": 1720508400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 1002,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 1002,\n \"timestamp\": 1720512000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 33,\n \"opened_count\": 6,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 33,\n \"timestamp\": 1720522800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 502,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 502,\n \"timestamp\": 1720526400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 6,\n \"opened_count\": 1,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 6,\n \"timestamp\": 1720594800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 34,\n \"opened_count\": 5,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 34,\n \"timestamp\": 1720598400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 502,\n \"opened_count\": 101,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 502,\n \"timestamp\": 1720602000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 471,\n \"opened_count\": 404,\n \"bounce_count\": 49,\n \"click_count\": 0,\n \"sent_count\": 520,\n \"timestamp\": 1720605600000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 84,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720609200000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 57,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720612800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 45,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720620000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 21,\n \"opened_count\": 0,\n \"bounce_count\": 11,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720630800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 32,\n \"opened_count\": 0,\n \"bounce_count\": 32,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720645200000\n }\n ],\n \"time_precision\": \"hourly\"\n },\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] } ] }, { "name": "License", "item": [ { "name": "Get license details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "license" ] } }, "response": [ { "name": "Prepaid license details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "license" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "194" }, { "key": "Date", "value": "Mon, 17 Apr 2023 07:41:17 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"license_details\": {\n \"total_credits\": 12000,\n \"credits_remaining\": 9984,\n \"expiry_time\": 1711087813000,\n \"plan\": \"PREPAID\"\n },\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the license details\"\n }\n}" }, { "name": "Postpaid license details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "license" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:49:34 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "165" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"license_details\": {\n \"expiry_time\": 1766903203000,\n \"plan\": \"POSTPAID\",\n \"credits_used\": 2\n },\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the license details\"\n }\n}" } ] } ] }, { "name": "Suppression", "item": [ { "name": "Get suppression", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "response": [ { "name": "Get suppression", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "528" }, { "key": "Date", "value": "Fri, 05 May 2023 06:13:59 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200401,\n \"message\": \"Successfully obtained the list of suppressed contacts\"\n },\n \"suppression\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\",\n \"added_time\": 1680612284111,\n \"modified_time\": 1680612284111,\n \"suppression_type\": \"MANUAL\",\n \"zuid\": 16304095\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\",\n \"added_time\": 1680612284111,\n \"modified_time\": 1680612284111,\n \"suppression_type\": \"MANUAL\",\n \"zuid\": 16304095\n }\n ],\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 1000\n }\n}" } ] }, { "name": "Add suppression", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"address\": \"zylker1@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n },\n {\n \"address\": \"zylker2@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "response": [ { "name": "Add suppression", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"address\": \"zylker1@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n },\n {\n \"address\": \"zylker2@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "319" }, { "key": "Date", "value": "Fri, 05 May 2023 06:09:57 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"suppressions_added\": [\n \"zylker1@zylker.com\"\n ],\n \"response\": {\n \"code\": 200402,\n \"message\": \"Suppressions added successfully\"\n },\n \"suppressions_already_existing\": [\n \"zylker2@zylker.com\"\n ]\n}" } ] }, { "name": "Delete suppression", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\"\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\"\n }\n \n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "response": [ { "name": "Delete suppression", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\"\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\"\n }\n \n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "201" }, { "key": "Date", "value": "Fri, 05 May 2023 06:11:49 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200403,\n \"message\": \"Suppressions deleted successfully\"\n },\n \"suppressions_ignored\": [\n \"zylker1@zylker.com\"\n ],\n \"suppressions_deleted\": [\n \"zylker2@zylker.com\"\n ]\n}" } ] } ] }, { "name": "Recipients", "item": [ { "name": "Get recipient list", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "response": [ { "name": "Get recipient list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients?start_index=1&end_index=5", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "5" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:51:12 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "938" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"List 12\",\n \"description\": \"LIST\",\n \"id\": \"1093639000409219001\"\n },\n {\n \"name\": \"1689228283\",\n \"description\": \"LIST\",\n \"id\": \"1093639000409189029\"\n },\n {\n \"name\": \"New List 1689237328\",\n \"description\": \"LIST 1689237328\",\n \"id\": \"1093639000409189059\"\n },\n {\n \"name\": \"New List 1689237770\",\n \"description\": \"LIST 1689237770\",\n \"id\": \"1093639000409219019\"\n },\n {\n \"name\": \"New List 1689242227\",\n \"description\": \"LIST 1689242227\",\n \"id\": \"1093639000409219081\"\n }\n ],\n \"count\": 139,\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 10\n }\n}" } ] }, { "name": "Get single recipient list details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/1093639000000046001?start_index=1&end_index=100", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "1093639000000046001" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "100" } ] } }, "response": [ { "name": "Get single recipient list details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/1093639000000046001?start_index=1&end_index=100", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "1093639000000046001" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:51:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": {\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"IN\",\n \"ph\": \"923123123123\"\n },\n \"address\": \"zylker1@zylker.com\",\n \"name\": \"Zylker\",\n \"merge_data\": {\n \"first_name\": \"zylker\"\n },\n \"status\": \"active\"\n },\n {\n \"additional_data\": {\n \"country\": \"IN\",\n \"ph\": \"923123123123\"\n },\n \"address\": \"zylker2@zylker.com\",\n \"name\": \"Zylker2\",\n \"merge_data\": {\n \"first_name\": \"zylker2\"\n },\n \"status\": \"active\"\n },\n ],\n \"name\": \"test list 1\",\n \"count\": 2,\n \"description\": \"test list 1\"\n },\n \"response\": {\n \"code\": 200502,\n \"message\": \"Successfully obtained the recipient list details\"\n },\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 100\n }\n}" } ] }, { "name": "Add recipient list", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients" ] } }, "response": [ { "name": "Add recipient list", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "100" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:39:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"list_id\": \"8000000128001\",\n \"response\": {\n \"code\": 200503,\n \"message\": \"Recipient list added successfully\"\n }\n}" } ] }, { "name": "Update recipient list", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/214548000000163084", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "214548000000163084" ] } }, "response": [ { "name": "Update recipient list", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "8000000128001" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "76" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:41:54 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200504,\n \"message\": \"Recipient list updated successfully\"\n }\n}" } ] }, { "name": "Delete recipient list", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "8000000128001" ] } }, "response": [ { "name": "Delete recipient list", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "recipients", "8000000128001" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "79" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:42:17 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200505,\n \"message\": \"Recipient list(s) deleted successfully\"\n }\n}" } ] } ] }, { "name": "Templates", "item": [ { "name": "Get all stored templates", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "response": [ { "name": "Get all stored templates", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:52:07 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the list of templates\"\n },\n \"templates\": [\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440489\",\n \"id\": \"1093639000412941073\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440499\",\n \"id\": \"1093639000412940206\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1697440494\",\n \"id\": \"1093639000412940204\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440494\",\n \"id\": \"1093639000412940202\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"text\",\n \"name\": \"New template \",\n \"id\": \"1093639000412940196\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1697441050\",\n \"id\": \"1093639000412939493\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1696826928\",\n \"id\": \"1093639000412689047\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696567658\",\n \"id\": \"1093639000412560001\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826782\",\n \"id\": \"1093639000412559078\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826706\",\n \"id\": \"1093639000412559076\",\n \"zuid\": 809553501\n }\n ],\n \"count\": 116,\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 10\n }\n}" } ] }, { "name": "Get stored template", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates/1093639000412559078", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates", "1093639000412559078" ] } }, "response": [ { "name": "Get stored template", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates/1093639000412559076", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates", "1093639000412559076" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:52:27 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "289" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200702,\n \"message\": \"Successfully obtained the template details\"\n },\n \"template_details\": {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826706\",\n \"id\": \"1093639000412559076\",\n \"content\": \"Hi this is test content..\",\n \"zuid\": 809553501\n }\n}" } ] }, { "name": "Create template - html", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 92878\",\n \"content\": \"

Hello world/h1>\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ] } }, "response": [ { "name": "Create template - html", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 92878\",\n \"content\": \"

Hello world/h1>\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:06:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "108" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200703,\n \"message\": \"Successfully added the template\"\n },\n \"template_id\": \"1093639000422588075\"\n}" } ] }, { "name": "Create template - text", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 91878111\",\n \"content\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\",\n \"content_type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ] } }, "response": [ { "name": "Create template - text", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 91878111\",\n \"content\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\",\n \"content_type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:07:08 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "108" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200703,\n \"message\": \"Successfully added the template\"\n },\n \"template_id\": \"1093639000422588077\"\n}" } ] }, { "name": "Edit stored template", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template 8\",\n \"content\": \"

Hello

\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates", "1093639000422588075" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:08:00 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "73" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200704,\n \"message\": \"Successfully edited the template\"\n }\n}" } ] }, { "name": "Delete stored template", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates", "1093639000422588075" ] } }, "response": [ { "name": "Delete stored template", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "templates", "1093639000422588075" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:08:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "74" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200705,\n \"message\": \"Successfully deleted the template\"\n }\n}" } ] } ] }, { "name": "User management", "item": [ { "name": "Get users", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users" ] } }, "response": [ { "name": "Get users", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "2955" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:08:45 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200601,\n \"message\": \"Successfully obtained the list of portal users\"\n },\n \"users\": [\n {\n \"email_id\": \"zylker1@zylker.com\",\n \"is_admin\": true,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16304095,\n \"is_confirmed\": true,\n \"name\": \"Zylker\",\n \"language\": \"en\",\n \"is_current_user\": true,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=162222304095\"\n },\n {\n \"email_id\": \"zylker2@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16305370,\n \"is_confirmed\": true,\n \"name\": \"Zylker 2\",\n \"language\": \"en\",\n \"is_current_user\": false,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=163105370\"\n },\n {\n \"email_id\": \"zylker3@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"invited\",\n \"is_confirmed\": false,\n \"name\": \"Zylker 3\",\n \"is_current_user\": false,\n \"user_photo\": \"/images/zc_nocontact.jpg\"\n }\n ]\n}" } ] }, { "name": "Get current user", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/current-user", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "current-user" ] } }, "response": [ { "name": "Get current user", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/current-user", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "current-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "444" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:09:06 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200602,\n \"message\": \"Successfully obtained the current user\"\n },\n \"current_user\": {\n \"email_id\": \"zylker1@zylker.com\",\n \"is_admin\": true,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16304095,\n \"is_confirmed\": true,\n \"name\": \"Zylker1\",\n \"language\": \"en\",\n \"is_current_user\": true,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=1630411095\"\n }\n}" } ] }, { "name": "Get user details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker2@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker2@zylker.com" ] } }, "response": [ { "name": "Get user details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker2@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker2@zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "444" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:09:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"user_details\": {\n \"email_id\": \"zylker2@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"active\",\n \"country\": \"us\",\n \"locale_info\": \"en_US\",\n \"user_zuid\": 16305813,\n \"is_confirmed\": true,\n \"name\": \"Zylker\",\n \"language\": \"en\",\n \"is_current_user\": false,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=16111305813\"\n },\n \"response\": {\n \"code\": 200603,\n \"message\": \"Successfully obtained the user details\"\n }\n}" } ] }, { "name": "Add user", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker1@zylker.com\",\n \"user_name\": \"Zylker1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users" ] } }, "response": [ { "name": "Add user", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker1@zylker.com\",\n \"user_name\": \"Zylker1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "80" }, { "key": "Date", "value": "Wed, 22 Mar 2023 12:57:49 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"An invitation has been sent to the user\"\n }\n}" }, { "name": "Add user - already exists", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker2@zylker.com\",\n \"user_name\": \"Zylker 2\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "60" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:22:13 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"code\": 400503,\n \"message\": \"User already exists\"\n }\n ]\n}" } ] }, { "name": "Mark user active", "request": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker1@zylker.com/mark-active", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker1@zylker.com", "mark-active" ] } }, "response": [ { "name": "Mark user active", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker@zylker1.com/mark-active", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker@zylker1.com", "mark-active" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "77" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:26:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"Successfully updated the user status\"\n }\n}" } ] }, { "name": "Mark user inactive", "request": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker1@zylker.com/mark-inactive", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker1@zylker.com", "mark-inactive" ] } }, "response": [ { "name": "Mark user inactive", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker1@zylker.com/mark-inactive", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker1@zylker.com", "mark-inactive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "77" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:27:04 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"Successfully updated the user status\"\n }\n}" } ] }, { "name": "Delete user", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker1@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker1@zylker.com" ] } }, "response": [ { "name": "Delete user", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v1/settings/users/zylker1@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v1", "settings", "users", "zylker1@zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "70" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:06:56 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200609,\n \"message\": \"Successfully deleted the user\"\n }\n}" } ] } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "refreshTokenUrl", "value": "https://{{zoho-accounts-domain-ct}}/oauth/v2/token", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "state", "value": "StateTest", "type": "string" }, { "key": "scope", "value": "ZohoCampaigns.campaign.ALL", "type": "string" }, { "key": "clientSecret", "value": "{{oauth-client-secret-ct2}}", "type": "string" }, { "key": "clientId", "value": "{{oauth-client-id-ct2}}", "type": "string" }, { "key": "accessTokenUrl", "value": "https://{{zoho-accounts-domain-ct}}/oauth/v2/token", "type": "string" }, { "key": "tokenName", "value": "Email API token", "type": "string" }, { "key": "authUrl", "value": "https://{{zoho-accounts-domain-ct}}/oauth/v2/auth?access_type=offline", "type": "string" }, { "key": "headerPrefix", "value": "Zoho-oauthtoken", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" } ] } }, { "name": "v2 - API key", "item": [ { "name": "Transmission", "item": [ { "name": "Send Email", "item": [ { "name": "A simple request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "A simple request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588002\"\n}" } ] }, { "name": "With Template ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"template_id\": \"1093639000412559078\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "With Template ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n },\n ],\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n \n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"template_id\": \"1093639000412559078\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:57:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588055\"\n}" } ] }, { "name": "With Recipient list ID", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"ea_test_1\",\n \"recipient_list_id\": \"1093639000000046001\",\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"EA test 1\",\n \"html\": \"Welcome $[first_name|Customer]$, your content here $[first_name|Customer]$\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "With Recipient list ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"campaign_name\": \"ea_test_1\",\n \"recipient_list_id\": \"1093639000000046001\",\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"EA test 1\",\n \"html\": \"Welcome $[first_name|Customer]$, your content here $[first_name|Customer]$\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 5,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With schedule option", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"schedule_at\": 1728474636000\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "With schedule option", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"schedule_at\": 1728474636000\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With tracking disabled", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "With tracking disabled", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"open_tracking\": \"disabled\",\n \"click_tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here\",\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] }, { "name": "With unsubscribe link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here

Unsubscribe\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission" ] } }, "response": [ { "name": "With unsubscribe link", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transmission_name\": \"My first Email API Campaign\",\n \"recipients\": [\n {\n \"address\": \"john.doe@zylker.com\",\n \"name\": \"John Doe\",\n \"additional_data\": {\n \"country\": \"JP\",\n \"ph\": \"1239333320\"\n },\n \"merge_data\": {\n \"first_name\": \"John\"\n }\n }\n ],\n \"options\": {\n \"tracking\": \"disabled\"\n },\n \"content\": {\n \"from\": {\n \"address\": \"aron.ea@zylker.com\",\n \"name\": \"Aaron\"\n },\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"html\": \"Welcome $[first_name|Customer]$, your content goes here

Unsubscribe\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:55:28 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] }, { "name": "Get transmission details", "item": [ { "name": "Get transmission details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Get transmission details", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:57:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"transmission_details\": {\n \"subject\": \"Hello $[first_name|Customer]$\",\n \"from\": \"aron.ea@zylker.com\",\n \"transmission_name\": \"My first Email API Campaign\",\n \"status\": \"Reviewed\",\n \"sent_time\": 1728472166000,\n \"options\": {\n \"open_tracking\": \"disabled\",\n \"click_tracking\": \"disabled\"\n }\n },\n \"response\": {\n \"code\": 200004,\n \"message\": \"Successfully obtained the transmission details\"\n }\n}" } ] } ] }, { "name": "Reschedule transmission", "item": [ { "name": "Reschedule transmission", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"schedule_at\": 1728472166000\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Reschedule transmission", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"schedule_at\": 1728472166000\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"rejected_recipients\": 0,\n \"accepted_recipients\": 1,\n \"response\": {\n \"code\": 200001,\n \"message\": \"Your transmission has been scheduled successfully\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] }, { "name": "Cancel transmission", "item": [ { "name": "Cancel transmission", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "response": [ { "name": "Cancel transmission", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/transmission/1093639000422588023", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "transmission", "1093639000422588023" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:44:59 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "170" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200003,\n \"message\": \"Scheduled transmission has been successfully canceled\"\n },\n \"transmission_id\": \"1093639000422588023\"\n}" } ] } ] } ] }, { "name": "Domain Settings", "item": [ { "name": "Sending and Bounce Domains", "item": [ { "name": "Add a domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "response": [ { "name": "Add a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"send1.zylker.in\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"send1.zylker.in\",\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"141510._domainkey.send1.zylker.in\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDbGG0RcWh6uIinKlVpSVNG2LWMHbITApd9K4sIHq5Dz71HO1jUCfkAGHQEyjMn6K1GrHOMclLVMa8+cMryIJbX8gOciP9gOXKtw1ib+YAdQl0fXjQgpOdf8CnWhT2uvfAy/2TUY9BBFBIll5R7+iL1omjGZ6hlAUZbC1Nu07qIVQIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"bounce.send1.zylker.in\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"74665059.sender1.localcampaign1.com\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Add a domain with bounce domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\",\n \"bounce_domain\": \"custom-bounce.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "response": [ { "name": "Add a domain with custom bounce domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.com\",\n \"bounce_domain\": \"custom-bounce.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"zylker.com\",\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"141510._domainkey.zylker.com\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDbGG0RcWh6uIinKlVpSVNG2LWMHbITApd9K4sIHq5Dz71HO1jUCfkAGHQEyjMn6K1GrHOMclLVMa8+cMryIJbX8gOciP9gOXKtw1ib+YAdQl0fXjQgpOdf8CnWhT2uvfAy/2TUY9BBFBIll5R7+iL1omjGZ6hlAUZbC1Nu07qIVQIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"custom-bounce.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"74665059.sender.campaign.com\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Get the list of domains", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "response": [ { "name": "Get the list of domains", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:35:23 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "346" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200101,\n \"message\": \"Successfully obtained the list of configured domains\"\n },\n \"domains\": [\n {\n \"domain_name\": \"zylker.com\",\n \"is_sending_domain_verified\": false,\n \"is_bounce_domain_verified\": false,\n \"is_verified\": false\n },\n {\n \"domain_name\": \"zylker2.com\",\n \"is_sending_domain_verified\": true,\n \"is_bounce_domain_verified\": true,\n \"is_verified\": true\n }\n ]\n}" } ] }, { "name": "Get single domain details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/emailapi.test.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "emailapi.test.com" ] } }, "response": [ { "name": "Get single domain details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/emailapi.test.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "emailapi.test.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 09:55:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"domain_name\": \"emailapi.test.com\",\n \"response\": {\n \"code\": 200105,\n \"message\": \"Successfully obtained the domain details\"\n },\n \"sending_domain\": {\n \"dns_host_name\": \"16255._domainkey.emailapi.test.com\",\n \"dns_record_type\": \"TXT\",\n \"dns_value\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrRqJ3aUrglbLI30QkxsfFkohu/bqrNfPAsQpy0c0F1nLhbem9n9BawQQVE2f/qug0p26FaK1Be0rSAX1s7/9TB0tHuwBbTKNsGgvJmu41kRwnXAnfXs+rsQWThzW/L5/vUsJFF3Utb4U5ng6eQZ0KhRmIfDTk8wgS2blSabSbIwIDAQAB\",\n \"is_verified\": false\n },\n \"bounce_domain\": {\n \"dns_host_name\": \"bounce.emailapi.test.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"809553610.send.zcsend.net\",\n \"is_verified\": false\n }\n}" } ] }, { "name": "Verify a domain", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "verify" ] } }, "response": [ { "name": "Verify a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:20 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "132" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"verify_result\": {\n \"sending_domain\": true,\n \"bounce_domain\": true\n },\n \"response\": {\n \"code\": 200103,\n \"message\": \"Domain verification successful\"\n }\n}" } ] }, { "name": "Delete a domain", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"emailapi-rybqLgv.test.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "response": [ { "name": "Delete a domain", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"zylker.in\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:41:47 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "68" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200104,\n \"message\": \"Domain deleted successfully\"\n }\n}" } ] } ] }, { "name": "Tracking Domains", "item": [ { "name": "Add a domain", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/tracking", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking" ] } }, "response": [ { "name": "Add a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain/tracking", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200102,\n \"message\": \"Domain added successfully\"\n },\n \"tracking_domain\": {\n \"dns_host_name\": \"track.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"campaigns.ca.zohohosts.com\",\n \"verify_status\": \"Unauthenticated\",\n \"is_default\": false\n }\n}" } ] }, { "name": "Get the list of domains", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/tracking", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking" ] } }, "response": [ { "name": "Get the list of domains", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain/tracking", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:35:23 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "346" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200101,\n \"message\": \"Successfully obtained the list of configured domains\"\n },\n \"domains\": [\n {\n \"verify_status\": \"Unauthenticated\",\n \"domain_name\": \"testing1.com\",\n \"added_time\": 1723188780000,\n \"is_default\": false\n },\n {\n \"verify_status\": \"Pending\",\n \"domain_name\": \"tracking.wakeupwith.in\",\n \"added_time\": 1725012968000,\n \"is_default\": false\n },\n {\n \"verify_status\": \"Authenticated\",\n \"domain_name\": \"track.zylker.com\",\n \"added_time\": 1726640934000,\n \"is_default\": true\n }\n ]\n}" } ] }, { "name": "Get single domain details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/tracking/track.zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking", "track.zylker.com" ] } }, "response": [ { "name": "Get single domain details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain/tracking/track.zylker.com", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking", "track.zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 09:55:22 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "618" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200105,\n \"message\": \"Successfully obtained the domain details\"\n },\n \"tracking_domain\": {\n \"dns_host_name\": \"track.zylker.com\",\n \"dns_record_type\": \"CNAME\",\n \"dns_value\": \"campaigns.cs.zohohost.com\",\n \"verify_status\": \"Unauthenticated\",\n \"is_default\": false\n }\n}" } ] }, { "name": "Verify a domain", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "verify" ] } }, "response": [ { "name": "Verify a domain", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/verify", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:20 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "132" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"verify_result\": \"Pending\",\n \"response\": {\n \"code\": 200109,\n \"message\": \"Tracking domain verification is in progress\"\n }\n}" } ] }, { "name": "Mark a domain as default", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain/tracking/default", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking", "default" ] } }, "response": [ { "name": "Mark a domain as default", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain/tracking/default", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain", "tracking", "default" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:40:07 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "599" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200108,\n \"message\": \"Default tracking domain enabled successfully\"\n }\n}" } ] }, { "name": "Delete a domain", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"tracking_domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/domain", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "response": [ { "name": "Delete a domain", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"domain\": \"track.zylker.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/domain", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:41:47 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "68" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200106,\n \"message\": \"Tracking domain deleted successfully\"\n }\n}" } ] } ] } ] }, { "name": "Webhook Settings", "item": [ { "name": "Create a webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Create a webhook - no auth", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook - no auth", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Create a webhook - auth token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Auth Token\",\n \"auth_token\": \"authtoken\"\n }\n}" }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "response": [ { "name": "Create a webhook - auth token", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bounceone\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Auth Token\",\n \"auth_token\": \"authtoken\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:43:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "262" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n },\n \"response\": {\n \"code\": 200203,\n \"message\": \"Webhook created successfully\"\n }\n}" } ] }, { "name": "Modify a webhook", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce new webhook 1\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\",\n \"webhook_actions\": [\n \"bounce\",\n \"spam\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook/214548000000287005", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook", "214548000000287005" ] } }, "response": [ { "name": "Modify a webhook", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bounce new webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\",\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"password\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/webhook/146429000000060005", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "webhook", "146429000000060005" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:45:45 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "210" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce new webhook\",\n \"type\": \"POST\",\n \"url\": \"https://zylker.com/bouncetwo\"\n },\n \"response\": {\n \"code\": 200204,\n \"message\": \"Webhook edited successfully\"\n }\n}" } ] }, { "name": "Delete a webhook", "request": { "method": "DELETE", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook/1093639000412560003", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook", "1093639000412560003" ] } }, "response": [ { "name": "Delete a webhook", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook/1093639000412560003", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook", "1093639000412560003" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:46:31 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "104" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook_id\": \"1093639000412560003\",\n \"response\": {\n \"code\": 200205,\n \"message\": \"Webhook deleted successfully\"\n }\n}" } ] }, { "name": "Get webhook details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook/214548000000069220", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook", "214548000000069220" ] } }, "response": [ { "name": "Get webhook details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/settings/webhook/146429000000060005", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "settings", "webhook", "146429000000060005" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:45:05 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "636" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"webhook\": {\n \"is_virtual\": false,\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_actions\": [\n \"bounce\"\n ],\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"version\": 2,\n \"url\": \"https://zylker.com/bounceone\",\n \"authorization\": {\n \"auth_type\": \"Username\",\n \"auth_username\": \"zylker\",\n \"auth_password\": \"zylker\",\n },\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"field_list\": {\n \"146429000000000021\": \"contact_email\"\n },\n \"custom_data\": {\n \"data\": {\n \"module\": \"workflow\",\n \"region\": \"EU\"\n },\n \"status\": true\n },\n \"custom_headers\": {\n \"headers\": {\n \"Webhook-Type\": \"Bounce\"\n },\n \"status\": true\n }\n },\n \"response\": {\n \"code\": 200202,\n \"message\": \"Successfully obtained the webhook details\"\n }\n}" } ] }, { "name": "Get all webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "response": [ { "name": "Get all webhooks", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/webhook", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 14 Mar 2023 09:44:10 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "345" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"from_index\": 0,\n \"total_webhook_count\": 1,\n \"webhook_list\": [\n {\n \"created_time\": \"1678787035101\",\n \"is_active\": true,\n \"webhook_id\": \"146429000000060005\",\n \"name\": \"Bounce webhook\",\n \"type\": \"POST\",\n \"created_by\": \"Zylker\",\n \"url\": \"https://zylker.com/bounceone\"\n }\n ],\n \"response\": {\n \"code\": 200201,\n \"message\": \"Successfully obtained the list of configured webhooks\"\n },\n \"limit\": 200\n}" } ] } ] }, { "name": "Reports", "item": [ { "name": "Events", "item": [ { "name": "Open report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/open?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "open" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Open report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/open?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "open" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Click report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/click?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "click" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Click report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/click?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "click" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"click_url\": \"https://zylker.com\",\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"click_url\": \"https://zylker.com\",\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Bounce report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/bounce?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "bounce" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Bounce report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/bounce?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "bounce" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"bounce_type\": \"hardbounce\",\n \"action_time\": 1733397337000,\n \"injected_time\": 1733426111000,\n \"bounce_dsn\": \"Permanent failure :bad-domain\",\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911231444832\"\n },\n \"transmission_id\": 1231400009461002,\n \"contact_id\": 512310009462015,\n \"transmission_name\": \"API CAMPAIGN IDC - 1\",\n \"zuid\": 12391,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] }, { "name": "Spam report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/spam?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "spam" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "response": [ { "name": "Spam report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/event/spam?from=1733097600000&to=1735794302000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "event", "spam" ], "query": [ { "key": "from", "value": "1733097600000" }, { "key": "to", "value": "1735794302000" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420002,\n \"contact_id\": 8001230002420014,\n \"transmission_name\": \"API CAMPAIGN 1\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n },\n {\n \"action_time\": 1733312488000,\n \"injected_time\": 1733312405000,\n \"rcpt_additional_data\": {\n \"country\": \"India\",\n \"Phone\": \"+911234567890\",\n \"id\": 173333220452133\n },\n \"transmission_id\": 8012300002420003,\n \"contact_id\": 8001230002420015,\n \"transmission_name\": \"API CAMPAIGN 2\",\n \"zuid\": 123145,\n \"contact_email\": \"john@zylker.com\"\n }\n ],\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] } ] }, { "name": "Summary Report", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/reports/delivery/summary?from=1710571707000&to=1721112520000", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "reports", "delivery", "summary" ], "query": [ { "key": "from", "value": "1710571707000" }, { "key": "to", "value": "1721112520000" } ] } }, "response": [ { "name": "Summary Report", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://campaigns.zoho.com/emailapi/v2/reports/delivery/summary?from=1710571707000&to=1721112520000", "protocol": "https", "host": [ "campaigns", "zoho", "com" ], "path": [ "emailapi", "v2", "reports", "delivery", "summary" ], "query": [ { "key": "from", "value": "1710571707000" }, { "key": "to", "value": "1721112520000" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:48:46 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": {\n \"summary\": {\n \"total_sent_count\": 2611,\n \"total_delivered_count\": 2411,\n \"total_opened_count\": 50,\n \"total_click_count\": 45,\n \"total_bounce_count\": 20,\n \"total_spam_count\": 0\n },\n \"stats\": [\n {\n \"spam_count\": 0,\n \"delivered_count\": 6,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 6,\n \"timestamp\": 1720508400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 1002,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 1002,\n \"timestamp\": 1720512000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 33,\n \"opened_count\": 6,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 33,\n \"timestamp\": 1720522800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 502,\n \"opened_count\": 0,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 502,\n \"timestamp\": 1720526400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 6,\n \"opened_count\": 1,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 6,\n \"timestamp\": 1720594800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 34,\n \"opened_count\": 5,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 34,\n \"timestamp\": 1720598400000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 502,\n \"opened_count\": 101,\n \"bounce_count\": 0,\n \"click_count\": 0,\n \"sent_count\": 502,\n \"timestamp\": 1720602000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 471,\n \"opened_count\": 404,\n \"bounce_count\": 49,\n \"click_count\": 0,\n \"sent_count\": 520,\n \"timestamp\": 1720605600000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 84,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720609200000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 57,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720612800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 0,\n \"opened_count\": 0,\n \"bounce_count\": 45,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720620000000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 21,\n \"opened_count\": 0,\n \"bounce_count\": 11,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720630800000\n },\n {\n \"spam_count\": 0,\n \"delivered_count\": 32,\n \"opened_count\": 0,\n \"bounce_count\": 32,\n \"click_count\": 0,\n \"sent_count\": 0,\n \"timestamp\": 1720645200000\n }\n ],\n \"time_precision\": \"hourly\"\n },\n \"response\": {\n \"code\": 200301,\n \"message\": \"Successfully obtained the reports for the given criteria\"\n }\n}" } ] } ] }, { "name": "License", "item": [ { "name": "Get license details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "license" ] } }, "response": [ { "name": "Prepaid license details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "license" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "194" }, { "key": "Date", "value": "Mon, 17 Apr 2023 07:41:17 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"license_details\": {\n \"total_credits\": 12000,\n \"credits_remaining\": 9984,\n \"expiry_time\": 1711087813000,\n \"plan\": \"PREPAID\"\n },\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the license details\"\n }\n}" }, { "name": "Postpaid license details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/license", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "license" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:49:34 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "165" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"license_details\": {\n \"expiry_time\": 1766903203000,\n \"plan\": \"POSTPAID\",\n \"credits_used\": 2\n },\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the license details\"\n }\n}" } ] } ] }, { "name": "Suppression", "item": [ { "name": "Get suppression", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "response": [ { "name": "Get suppression", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "528" }, { "key": "Date", "value": "Fri, 05 May 2023 06:13:59 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200401,\n \"message\": \"Successfully obtained the list of suppressed contacts\"\n },\n \"suppression\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\",\n \"added_time\": 1680612284111,\n \"modified_time\": 1680612284111,\n \"suppression_type\": \"MANUAL\",\n \"zuid\": 16304095\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\",\n \"added_time\": 1680612284111,\n \"modified_time\": 1680612284111,\n \"suppression_type\": \"MANUAL\",\n \"zuid\": 16304095\n }\n ],\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 1000\n }\n}" } ] }, { "name": "Add suppression", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"address\": \"zylker1@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n },\n {\n \"address\": \"zylker2@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "response": [ { "name": "Add suppression", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"address\": \"zylker1@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n },\n {\n \"address\": \"zylker2@zylker.com\",\n \"additional_data\" : {\n \"country\": \"India\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "319" }, { "key": "Date", "value": "Fri, 05 May 2023 06:09:57 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"suppressions_added\": [\n \"zylker1@zylker.com\"\n ],\n \"response\": {\n \"code\": 200402,\n \"message\": \"Suppressions added successfully\"\n },\n \"suppressions_already_existing\": [\n \"zylker2@zylker.com\"\n ]\n}" } ] }, { "name": "Delete suppression", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\"\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\"\n }\n \n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "response": [ { "name": "Delete suppression", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker1@zylker.com\"\n },\n {\n \"additional_data\": {\n \"country\": \"India\"\n },\n \"address\": \"zylker2@zylker.com\"\n }\n \n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/suppression", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "suppression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "201" }, { "key": "Date", "value": "Fri, 05 May 2023 06:11:49 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200403,\n \"message\": \"Suppressions deleted successfully\"\n },\n \"suppressions_ignored\": [\n \"zylker1@zylker.com\"\n ],\n \"suppressions_deleted\": [\n \"zylker2@zylker.com\"\n ]\n}" } ] } ] }, { "name": "Recipients", "item": [ { "name": "Get recipient list", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "response": [ { "name": "Get recipient list", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients?start_index=1&end_index=5", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "5" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:51:12 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "938" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"List 12\",\n \"description\": \"LIST\",\n \"id\": \"1093639000409219001\"\n },\n {\n \"name\": \"1689228283\",\n \"description\": \"LIST\",\n \"id\": \"1093639000409189029\"\n },\n {\n \"name\": \"New List 1689237328\",\n \"description\": \"LIST 1689237328\",\n \"id\": \"1093639000409189059\"\n },\n {\n \"name\": \"New List 1689237770\",\n \"description\": \"LIST 1689237770\",\n \"id\": \"1093639000409219019\"\n },\n {\n \"name\": \"New List 1689242227\",\n \"description\": \"LIST 1689242227\",\n \"id\": \"1093639000409219081\"\n }\n ],\n \"count\": 139,\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 10\n }\n}" } ] }, { "name": "Get single recipient list details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/1093639000000046001?start_index=1&end_index=100", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "1093639000000046001" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "100" } ] } }, "response": [ { "name": "Get single recipient list details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/1093639000000046001?start_index=1&end_index=100", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "1093639000000046001" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:51:36 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"data\": {\n \"recipients\": [\n {\n \"additional_data\": {\n \"country\": \"IN\",\n \"ph\": \"923123123123\"\n },\n \"address\": \"zylker1@zylker.com\",\n \"name\": \"Zylker\",\n \"merge_data\": {\n \"first_name\": \"zylker\"\n },\n \"status\": \"active\"\n },\n {\n \"additional_data\": {\n \"country\": \"IN\",\n \"ph\": \"923123123123\"\n },\n \"address\": \"zylker2@zylker.com\",\n \"name\": \"Zylker2\",\n \"merge_data\": {\n \"first_name\": \"zylker2\"\n },\n \"status\": \"active\"\n },\n ],\n \"name\": \"test list 1\",\n \"count\": 2,\n \"description\": \"test list 1\"\n },\n \"response\": {\n \"code\": 200502,\n \"message\": \"Successfully obtained the recipient list details\"\n },\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 100\n }\n}" } ] }, { "name": "Add recipient list", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients" ] } }, "response": [ { "name": "Add recipient list", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "100" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:39:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"list_id\": \"8000000128001\",\n \"response\": {\n \"code\": 200503,\n \"message\": \"Recipient list added successfully\"\n }\n}" } ] }, { "name": "Update recipient list", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/214548000000163084", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "214548000000163084" ] } }, "response": [ { "name": "Update recipient list", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Contacts list 2\",\n \"description\": \"Contacts list 5\",\n \"recipients\": [\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker1.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker2.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker2\"\n }\n },\n {\n \"additional_data\": {\n \"phone\": \"+911234567890\"\n },\n \"address\": \"zylker1@zylker3.com\",\n \"merge_data\": {\n \"first_name\": \"Zylker3\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "8000000128001" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "76" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:41:54 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200504,\n \"message\": \"Recipient list updated successfully\"\n }\n}" } ] }, { "name": "Delete recipient list", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "8000000128001" ] } }, "response": [ { "name": "Delete recipient list", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/recipients/8000000128001", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "recipients", "8000000128001" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "79" }, { "key": "Date", "value": "Mon, 03 Apr 2023 09:42:17 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200505,\n \"message\": \"Recipient list(s) deleted successfully\"\n }\n}" } ] } ] }, { "name": "Templates", "item": [ { "name": "Get all stored templates", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "response": [ { "name": "Get all stored templates", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates?start_index=1&end_index=10", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ], "query": [ { "key": "start_index", "value": "1" }, { "key": "end_index", "value": "10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:52:07 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "vary", "value": "accept-encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200701,\n \"message\": \"Successfully obtained the list of templates\"\n },\n \"templates\": [\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440489\",\n \"id\": \"1093639000412941073\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440499\",\n \"id\": \"1093639000412940206\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1697440494\",\n \"id\": \"1093639000412940204\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1697440494\",\n \"id\": \"1093639000412940202\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"text\",\n \"name\": \"New template \",\n \"id\": \"1093639000412940196\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1697441050\",\n \"id\": \"1093639000412939493\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"New Template 1696826928\",\n \"id\": \"1093639000412689047\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696567658\",\n \"id\": \"1093639000412560001\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826782\",\n \"id\": \"1093639000412559078\",\n \"zuid\": 809553501\n },\n {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826706\",\n \"id\": \"1093639000412559076\",\n \"zuid\": 809553501\n }\n ],\n \"count\": 116,\n \"range\": {\n \"start_index\": 1,\n \"end_index\": 10\n }\n}" } ] }, { "name": "Get stored template", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates/1093639000412559078", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates", "1093639000412559078" ] } }, "response": [ { "name": "Get stored template", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates/1093639000412559076", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates", "1093639000412559076" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 06:52:27 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "289" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200702,\n \"message\": \"Successfully obtained the template details\"\n },\n \"template_details\": {\n \"content_type\": \"html\",\n \"name\": \"Edit Html Template 1696826706\",\n \"id\": \"1093639000412559076\",\n \"content\": \"Hi this is test content..\",\n \"zuid\": 809553501\n }\n}" } ] }, { "name": "Create template - html", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 92878\",\n \"content\": \"

Hello world/h1>\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ] } }, "response": [ { "name": "Create template - html", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 92878\",\n \"content\": \"

Hello world/h1>\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:06:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "108" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200703,\n \"message\": \"Successfully added the template\"\n },\n \"template_id\": \"1093639000422588075\"\n}" } ] }, { "name": "Create template - text", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 91878111\",\n \"content\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\",\n \"content_type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ] } }, "response": [ { "name": "Create template - text", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template snk 91878111\",\n \"content\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\",\n \"content_type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:07:08 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "108" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200703,\n \"message\": \"Successfully added the template\"\n },\n \"template_id\": \"1093639000422588077\"\n}" } ] }, { "name": "Edit stored template", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"template_name\": \"template 8\",\n \"content\": \"

Hello

\",\n \"content_type\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates", "1093639000422588075" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:08:00 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "73" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200704,\n \"message\": \"Successfully edited the template\"\n }\n}" } ] }, { "name": "Delete stored template", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates", "1093639000422588075" ] } }, "response": [ { "name": "Delete stored template", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/templates/1093639000422588075", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "templates", "1093639000422588075" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Server", "value": "ZGS" }, { "key": "Date", "value": "Tue, 16 Jul 2024 10:08:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "74" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200705,\n \"message\": \"Successfully deleted the template\"\n }\n}" } ] } ] }, { "name": "User management", "item": [ { "name": "Get users", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users" ] } }, "response": [ { "name": "Get users", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "2955" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:08:45 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200601,\n \"message\": \"Successfully obtained the list of portal users\"\n },\n \"users\": [\n {\n \"email_id\": \"zylker1@zylker.com\",\n \"is_admin\": true,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16304095,\n \"is_confirmed\": true,\n \"name\": \"Zylker\",\n \"language\": \"en\",\n \"is_current_user\": true,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=162222304095\"\n },\n {\n \"email_id\": \"zylker2@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16305370,\n \"is_confirmed\": true,\n \"name\": \"Zylker 2\",\n \"language\": \"en\",\n \"is_current_user\": false,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=163105370\"\n },\n {\n \"email_id\": \"zylker3@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"invited\",\n \"is_confirmed\": false,\n \"name\": \"Zylker 3\",\n \"is_current_user\": false,\n \"user_photo\": \"/images/zc_nocontact.jpg\"\n }\n ]\n}" } ] }, { "name": "Get current user", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/current-user", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "current-user" ] } }, "response": [ { "name": "Get current user", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/current-user", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "current-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "444" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:09:06 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200602,\n \"message\": \"Successfully obtained the current user\"\n },\n \"current_user\": {\n \"email_id\": \"zylker1@zylker.com\",\n \"is_admin\": true,\n \"user_status\": \"active\",\n \"country\": \"in\",\n \"locale_info\": \"en_IN\",\n \"user_zuid\": 16304095,\n \"is_confirmed\": true,\n \"name\": \"Zylker1\",\n \"language\": \"en\",\n \"is_current_user\": true,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=1630411095\"\n }\n}" } ] }, { "name": "Get user details", "request": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker2@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker2@zylker.com" ] } }, "response": [ { "name": "Get user details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker2@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker2@zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "444" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:09:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"user_details\": {\n \"email_id\": \"zylker2@zylker.com\",\n \"is_admin\": false,\n \"user_status\": \"active\",\n \"country\": \"us\",\n \"locale_info\": \"en_US\",\n \"user_zuid\": 16305813,\n \"is_confirmed\": true,\n \"name\": \"Zylker\",\n \"language\": \"en\",\n \"is_current_user\": false,\n \"time_zone\": \"Asia/Kolkata\",\n \"user_photo\": \"//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=16111305813\"\n },\n \"response\": {\n \"code\": 200603,\n \"message\": \"Successfully obtained the user details\"\n }\n}" } ] }, { "name": "Add user", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker1@zylker.com\",\n \"user_name\": \"Zylker1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users" ] } }, "response": [ { "name": "Add user", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker1@zylker.com\",\n \"user_name\": \"Zylker1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Content-Length", "value": "80" }, { "key": "Date", "value": "Wed, 22 Mar 2023 12:57:49 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"An invitation has been sent to the user\"\n }\n}" }, { "name": "Add user - already exists", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email_id\": \"zylker2@zylker.com\",\n \"user_name\": \"Zylker 2\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "60" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:22:13 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"code\": 400503,\n \"message\": \"User already exists\"\n }\n ]\n}" } ] }, { "name": "Mark user active", "request": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker1@zylker.com/mark-active", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker1@zylker.com", "mark-active" ] } }, "response": [ { "name": "Mark user active", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker@zylker1.com/mark-active", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker@zylker1.com", "mark-active" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "77" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:26:36 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"Successfully updated the user status\"\n }\n}" } ] }, { "name": "Mark user inactive", "request": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker1@zylker.com/mark-inactive", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker1@zylker.com", "mark-inactive" ] } }, "response": [ { "name": "Mark user inactive", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker1@zylker.com/mark-inactive", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker1@zylker.com", "mark-inactive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "77" }, { "key": "Date", "value": "Tue, 28 Mar 2023 07:27:04 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200607,\n \"message\": \"Successfully updated the user status\"\n }\n}" } ] }, { "name": "Delete user", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker1@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker1@zylker.com" ] } }, "response": [ { "name": "Delete user", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{zoho-campaigns-domain-x}}/emailapi/v2/settings/users/zylker1@zylker.com", "protocol": "https", "host": [ "{{zoho-campaigns-domain-x}}" ], "path": [ "emailapi", "v2", "settings", "users", "zylker1@zylker.com" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1" }, { "key": "Cache-Control", "value": "private,no-cache,no-store,max-age=0,must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "Thu, 01 Jan 1970 00:00:00 GMT" }, { "key": "X-Frame-Options", "value": "SAMEORIGIN" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "70" }, { "key": "Date", "value": "Tue, 28 Mar 2023 08:06:56 GMT" }, { "key": "Keep-Alive", "value": "timeout=20" }, { "key": "Connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"response\": {\n \"code\": 200609,\n \"message\": \"Successfully deleted the user\"\n }\n}" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "Zoho-zapikey {{api-key}}", "type": "string" } ] } } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "zoho-campaigns-domain-x", "value": "campaigns.zoho.com" }, { "key": "zoho-accounts-domain-x", "value": "accounts.zoho.com", "type": "string" }, { "key": "oauth-client-id-x", "value": "1000.****************************", "type": "string" }, { "key": "oauth-client-secret-x", "value": "*********************************", "type": "string" } ] }