{
"info": {
"_postman_id": "4c59d2b0-f1ac-4617-9c0a-6a49084d2711",
"name": "Unisender Go API Methods",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "116226"
},
"item": [
{
"name": "Email Methods",
"item": [
{
"name": "email-send",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"message\": {\r\n \"recipients\": [\r\n {\r\n \"email\": \"user@example.com\",\r\n \"substitutions\": {\r\n \"CustomerId\": 12452,\r\n \"to_name\": \"Иван\"\r\n },\r\n \"metadata\": {\r\n \"campaign_id\": \"c77f4f4e-3561-49f7-9f07-c35be01b4f43\",\r\n \"customer_hash\": \"b253ac7\"\r\n }\r\n }\r\n ],\r\n \"tags\": [\r\n \"tag1\"\r\n ],\r\n \"skip_unsubscribe\": 0,\r\n \"global_language\": \"ru\",\r\n \"template_engine\": \"simple\",\r\n \"global_substitutions\": {\r\n \"property1\": \"string1\",\r\n \"property2\": \"string2\"\r\n },\r\n \"global_metadata\": {\r\n \"property3\": \"string3\",\r\n \"property4\": \"string4\"\r\n },\r\n \"body\": {\r\n \"html\": \"Добрый день, {{to_name}}\",\r\n \"plaintext\": \"Добрый день, {{to_name}}\"\r\n },\r\n \"subject\": \"string\",\r\n \"from_email\": \"user@example.com\",\r\n \"from_name\": \"Иван\",\r\n \"reply_to\": \"user@example.com\",\r\n \"reply_to_name\": \"Иван\",\r\n \"track_links\": 0,\r\n \"track_read\": 0,\r\n \"bypass_global\": 0,\r\n \"bypass_unavailable\": 0,\r\n \"bypass_unsubscribed\": 0,\r\n \"bypass_complained\": 0,\r\n \"headers\": {\r\n \"X-MyHeader\": \"some data\"\r\n },\r\n \"attachments\": [\r\n {\r\n \"type\": \"text/plain\",\r\n \"name\": \"readme.txt\",\r\n \"content\": \"SGVsbG8sIHdvcmxkIQ==\"\r\n }\r\n ],\r\n \"inline_attachments\": [\r\n {\r\n \"type\": \"image/gif\",\r\n \"name\": \"IMAGECID1\",\r\n \"content\": \"R0lGODdhAwADAIABAP+rAP///ywAAAAAAwADAAACBIQRBwUAOw==\"\r\n }\r\n ]\r\n }\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/email/send.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"email",
"send.json"
]
}
},
"response": []
},
{
"name": "email-subscribe",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"from_email\": \"user@example.com\",\r\n \"from_name\": \"Иван\",\r\n \"to_email\": \"user@example.com\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/email/subscribe.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"email",
"subscribe.json"
]
}
},
"response": []
}
]
},
{
"name": "Email-validation Methods",
"item": [
{
"name": "email-validation-single",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\": \"user@example.com\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/email-validation/single.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"email-validation",
"single.json"
]
}
},
"response": []
}
]
},
{
"name": "Template Methods",
"item": [
{
"name": "template-set",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"template\": {\r\n \"name\": \"string\",\r\n \"template_engine\": \"simple\",\r\n \"global_substitutions\": {\r\n \"property1\": \"string1\",\r\n \"property2\": \"string2\"\r\n },\r\n \"global_metadata\": {\r\n \"property3\": \"string3\",\r\n \"property4\": \"string4\"\r\n },\r\n \"body\": {\r\n \"html\": \"Добрый день, {{to_name}}\",\r\n \"plaintext\": \"Добрый день, {{to_name}}\"\r\n },\r\n \"subject\": \"string\",\r\n \"from_email\": \"user@example.com\",\r\n \"from_name\": \"Иван\",\r\n \"reply_to\": \"user@example.com\",\r\n \"headers\": {\r\n \"X-MyHeader\": \"some data\"\r\n },\r\n \"attachments\": [\r\n {\r\n \"type\": \"text/plain\",\r\n \"name\": \"readme.txt\",\r\n \"content\": \"SGVsbG8sIHdvcmxkIQ==\"\r\n }\r\n ],\r\n \"inline_attachments\": [\r\n {\r\n \"type\": \"image/gif\",\r\n \"name\": \"IMAGECID1\",\r\n \"content\": \"R0lGODdhAwADAIABAP+rAP///ywAAAAAAwADAAACBIQRBwUAOw==\"\r\n }\r\n ]\r\n }\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/template/set.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"template",
"set.json"
]
}
},
"response": []
},
{
"name": "template-get",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"id\": \"bf822d10-1ef0-11ed-b000-d229d5fd57ae\"\r\n \r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/template/get.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"template",
"get.json"
]
}
},
"response": []
},
{
"name": "template-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"limit\": 50,\r\n \"offset\": 0\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/template/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"template",
"list.json"
]
}
},
"response": []
},
{
"name": "template-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"id\": \"bf822d10-1ef0-11ed-b000-d229d5fd57ae\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/template/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"template",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "Webhook Methods",
"item": [
{
"name": "webhook-set",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://yourhost.example.com/webhook\",\r\n \"status\": \"active\",\r\n \"event_format\": \"json_post\",\r\n \"delivery_info\": 0,\r\n \"single_event\": 0,\r\n \"max_parallel\": 10,\r\n \"events\": {\r\n \"spam_block\": [\r\n \"*\"\r\n ],\r\n \"email_status\": [\r\n \"delivered\",\r\n \"opened\",\r\n \"clicked\",\r\n \"unsubscribed\",\r\n \"subscribed\",\r\n \"soft_bounced\",\r\n \"hard_bounced\",\r\n \"spam\"\r\n ]\r\n }\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/webhook/set.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"webhook",
"set.json"
]
},
"description": "webhook/set"
},
"response": []
},
{
"name": "webhook-get",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://yourhost.example.com/webhook\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/webhook/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"webhook",
"list.json"
]
}
},
"response": []
},
{
"name": "webhook-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"limit\": 0,\r\n \"offset\": 0\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/webhook/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"webhook",
"list.json"
]
}
},
"response": []
},
{
"name": "webhook-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://yourhost.example.com/webhook\"\r\n }"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/webhook/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"webhook",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "Suppression Methods",
"item": [
{
"name": "suppression-set",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\": \"user@example.com\",\r\n \"cause\": \"unsubscribed\",\r\n \"created\": \"2021-12-19 10:15:49\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/suppression/set.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"suppression",
"set.json"
]
}
},
"response": []
},
{
"name": "suppression-get",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\": \"user@example.com\",\r\n \"all_projects\": false\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/suppression/get.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"suppression",
"get.json"
]
}
},
"response": []
},
{
"name": "suppression-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"cause\": \"unsubscribed\",\r\n \"source\": \"user\",\r\n \"start_time\": \"2020-10-14 17:00:00\",\r\n \"cursor\": \"Ajfb6Hvdkn3hdhhvG57xbdufhG5\",\r\n \"limit\": 50\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/suppression/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"suppression",
"list.json"
]
}
},
"response": []
},
{
"name": "suppression-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\": \"user@example.com\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/suppression/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"suppression",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "Domain Methods",
"item": [
{
"name": "domain-get-dns-records",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"domain\": \"example.com\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/domain/get-dns-records.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"domain",
"get-dns-records.json"
]
}
},
"response": []
},
{
"name": "domain-validate-verification-record",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"domain\": \"example.com\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/domain/validate-verification-record.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"domain",
"validate-verification-record.json"
]
}
},
"response": []
},
{
"name": "domain-validate-dkim",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"domain\": \"example.com\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/domain/validate-dkim.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"domain",
"validate-dkim.json"
]
}
},
"response": []
},
{
"name": "domain-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"domain\": \"example.com\",\r\n \"limit\": 50,\r\n \"offset\": 0\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/domain/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"domain",
"list.json"
]
}
},
"response": []
}
]
},
{
"name": "Event-dump Methods",
"item": [
{
"name": "event-dump-create",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"start_time\": \"2022-07-20 00:00:00\",\r\n \"end_time\": \"2022-07-21 00:00:00\",\r\n \"limit\": 50,\r\n \"all_projects\": false,\r\n \"filter\": {\r\n \"job_id\": \"1ZymBc-00041N-9X\",\r\n \"status\": \"hard_bounced\",\r\n \"delivery_status\": \"err_user_unknown\",\r\n \"email\": \"to@example.org\",\r\n \"email_from\": \"sender@example.com\",\r\n \"domain\": \"example.org\",\r\n \"campaign_id\": \"c77f4f4e-3561-49f7-9f07-c35be01b4f43\"\r\n },\r\n \"delimiter\": \";\",\r\n \"format\": \"csv\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/event-dump/create.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"event-dump",
"create.json"
]
}
},
"response": []
},
{
"name": "event-dump-get",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"dump_id\": \"Gqfasjh34tlasd\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/event-dump/get.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"event-dump",
"get.json"
]
}
},
"response": []
},
{
"name": "event-dump-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/event-dump/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"event-dump",
"list.json"
]
}
},
"response": []
},
{
"name": "event-dump-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"dump_id\": \"Gqfasjh34tlasd\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/event-dump/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"event-dump",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "Tag Methods",
"item": [
{
"name": "tag-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/tag/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"tag",
"list.json"
]
}
},
"response": []
},
{
"name": "tag-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"tag_id\": 645\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/tag/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"tag",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "Project Methods",
"item": [
{
"name": "project-create",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"project\": {\r\n \"name\": \"Project 1A\",\r\n \"country\": \"RU\",\r\n \"send_enabled\": true,\r\n \"custom_unsubscribe_url_enabled\": true,\r\n \"backend_id\": 1234\r\n }\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/project/create.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"project",
"create.json"
]
}
},
"response": []
},
{
"name": "project-update",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"project_id\": \"123456\",\r\n \"project\": {\r\n \"name\": \"Project 1A\",\r\n \"country\": \"RU\",\r\n \"send_enabled\": true,\r\n \"custom_unsubscribe_url_enabled\": true,\r\n \"backend_id\": 1234\r\n }\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/project/update.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"project",
"update.json"
]
}
},
"response": []
},
{
"name": "project-list",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"project_id\": \"123456\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/project/list.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"project",
"list.json"
]
}
},
"response": []
},
{
"name": "project-delete",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"project_id\": \"123456\"\r\n}"
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/project/delete.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"project",
"delete.json"
]
}
},
"response": []
}
]
},
{
"name": "System Methods",
"item": [
{
"name": "system-info",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://{{host}}/ru/transactional/api/v1/system/info.json",
"host": [
"https://{{host}}"
],
"path": [
"ru",
"transactional",
"api",
"v1",
"system",
"info.json"
]
}
},
"response": []
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "your_api_key",
"type": "string"
},
{
"key": "in",
"value": "header",
"type": "string"
},
{
"key": "key",
"value": "X-API-KEY",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
],
"variable": [
{
"key": "host",
"value": "go1.unisender.ru",
"type": "string"
}
]
}