{ "openapi":"3.1.0", "info":{ "title":"Infobip OpenAPI Specification", "description":"OpenAPI Specification that contains all public endpoints and webhooks.", "contact":{ "name":"Infobip support", "email":"support@infobip.com" }, "version":"3.210.0", "x-generatedAt":"2026-07-23T15:23:56.306162599Z" }, "tags":[ { "name":"channels", "description":"Create a perfect customer experience by using the channels your customer already use and love.\n", "x-type":"category", "x-displayName":"Channels" }, { "name":"email", "description":"Infobip Email is a cloud-based, all-in-one communication solution suited for both transactional and marketing email message delivery. It allows users to create rich, personalized, and responsive emails using API. Email messaging can be simple with ad-hoc one-way communication or more advanced with template management and scheduled sending.\n\n**Email validation**\nis an essential part of sending targeted emails is to ensure you have a clean list of engaged subscribers. Email validation acts as the first line of defense ensuring accuracy for both your new and existing email lists by providing if validated email is existing or not, aswell as providing you with additional info about mailbox: Valid syntax, Disposable mailbox, Role-based mailbox, Catch-all mailbox.\n", "x-type":"product", "x-displayName":"Email" }, { "name":"email-message-sending", "description":"", "x-type":"section", "x-displayName":"Outbound Email" }, { "name":"inbound-email", "description":"", "x-type":"section", "x-displayName":"Inbound Email" }, { "name":"scheduled-email", "description":"", "x-type":"section", "x-displayName":"Manage Scheduled Email Messages" }, { "name":"email-logs-and-reports", "description":"", "x-type":"section", "x-displayName":"Logs and Status Reports" }, { "name":"email-webhooks", "description":"", "x-type":"section", "x-displayName":"Webhooks" }, { "name":"email-validation", "description":"", "x-type":"section", "x-displayName":"Email Validation" }, { "name":"email-domains", "description":"", "x-type":"section", "x-displayName":"Email Domains" }, { "name":"email-suppression", "description":"", "x-type":"section", "x-displayName":"Email Suppression" }, { "name":"email-ip-management", "description":"", "x-type":"section", "x-displayName":"Email IP Management" }, { "name":"email-templates", "description":"", "x-type":"section", "x-displayName":"Email Templates" } ], "paths":{ "/email/4/messages":{ "post":{ "tags":[ "channels", "email", "email-message-sending" ], "summary":"Send email messages", "description":"99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Scheduling and every advanced feature you can think of is supported.", "externalDocs":{ "description":"Learn more about Email channel and use cases", "url":"https://www.infobip.com/docs/email" }, "operationId":"send-email-messages-api", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequest" }, "examples":{ "Email with text with single destination":{ "summary":"Email with text with single destination", "value":{ "messages":[ { "sender":"jenny.smith@company.com", "destinations":[ { "to":[ { "destination":"john.smith@company.com" } ] } ], "content":{ "subject":"Test message", "text":"Test body" } } ] } }, "Email with template with multiple destination":{ "summary":"Email with template with multiple destination", "value":{ "messages":[ { "sender":"jenny.smith@company.com", "destinations":[ { "to":[ { "destination":"john.smith@company.com", "placeholders":"{\"customer_name\":\"John Smith\"}" }, { "destination":"mike.smith@company.com", "placeholders":"{\"customer_name\":\"Mike Smith\"}" } ] } ], "content":{ "templateId":"322307", "defaultPlaceholders":"{\"date\":\"20/03/2018\",\"customer_name\":\"John Smith\"}" } } ] } }, "Email with HTML and placeholders with single destination":{ "summary":"Email with HTML and placeholders with single destination", "value":{ "messages":[ { "sender":"jenny.smith@company.com", "destinations":[ { "to":[ { "destination":"john.smith@company.com", "placeholders":"{\"destination_ph\":\"Destination placeholder\"}" } ] } ], "content":{ "subject":"Test message", "html":"
Rich HTML message body.
\nRich HTML message body.
\nRich HTML message body.
\"' \\\n--form 'attachment=@\"/home/user/image.png\"' \\\n--form 'bulkId=\"customBulkId\"' \\\n--form 'intermediateReport=\"true\"' \\\n--form-string 'defaultPlaceholders={\"ph1\": \"Success\", \"ph2\": \"Example\"}' \\\n--form-string 'headers={\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}' \\\n--form 'notifyUrl=\"https://www.example.com/email/advanced\"' \\\n--form 'notifyContentType=\"application/json\"' \\\n--form 'trackClicks=\"true\"' \\\n--form 'trackOpens=\"false\"' \\\n--form 'trackingPixelPosition=\"TOP\"' \\\n--form 'callbackData=\"DLR callback data\"'\n--form 'ipPoolId=\"08A3A7608750CC6E6080325A6ADF45B6\"'\n" }, "Send fully featured with preserved recipients email using curl":{ "summary":"Send fully featured with preserved recipients email using curl", "description":"Send fully featured with preserved recipients email using curl", "value":"\ncurl --request POST 'https://{base_url}/email/3/send' \\\n--header 'Authorization: Basic {username:password}' \\\n--form 'from=\"Jane SmithRich HTML message body.
\"' \\\n--form 'attachment=@\"/home/user/image.png\"' \\\n--form 'bulkId=\"customBulkId\"' \\\n--form 'intermediateReport=\"true\"' \\\n--form-string 'defaultPlaceholders={\"ph1\": \"Success\", \"ph2\": \"Example\"}' \\\n--form-string 'headers={\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}' \\\n--form 'notifyUrl=\"https://www.example.com/email/advanced\"' \\\n--form 'notifyContentType=\"application/json\"' \\\n--form 'trackClicks=\"true\"' \\\n--form 'trackOpens=\"false\"' \\\n--form 'trackingPixelPosition=\"TOP\"' \\\n--form 'callbackData=\"DLR callback data\"'\n--form 'ipPoolId=\"08A3A7608750CC6E6080325A6ADF45B6\"'\n" }, "Send fully featured email using Java":{ "summary":"Send fully featured email using Java", "description":"Send fully featured email using Java", "value":"\nimport org.springframework.core.io.FileSystemResource;\nimport org.springframework.http.*;\nimport org.springframework.util.LinkedMultiValueMap;\nimport org.springframework.web.client.RestTemplate;\nimport java.io.File; \n \nvar body = new LinkedMultiValueMapRich HTML message body.
\");\nbody.add(\"attachment\", new FileSystemResource(new File(\"/home/user/file.zip\")));\nbody.add(\"bulkId\", \"customBulkId\");\nbody.add(\"intermediateReport\", \"true\");\nbody.add(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\");\nbody.add(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\");\nbody.add(\"notifyUrl\", \"https://www.example.com/email/advanced\");\nbody.add(\"notifyContentType\", \"application/json\");\nbody.add(\"trackClicks\", \"true\");\nbody.add(\"trackOpens\", \"false\");\nbody.add(\"trackingPixelPosition\", \"TOP\");\nbody.add(\"callbackData\", \"DLR callback data\");\nbody.add(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\nvar headers = new HttpHeaders();\nheaders.setContentType(MediaType.MULTIPART_FORM_DATA);\nheaders.add(\"Authorization\", \"Basic {username:password}\");\nvar entity = new HttpEntity<>(body, headers);\nvar restTemplate = new RestTemplate();\nrestTemplate.postForEntity(\"https://{base_url}/email/3/send\", entity, String.class);\n" }, "Send fully featured email - HTTP":{ "summary":"Send fully featured email - HTTP", "description":"Send fully featured email - HTTP", "value":"\nPOST /email/3/send HTTP/1.1\nHost: {base_url}\nAuthorization: Basic {username:password}\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\n \n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"from\"\n \nJane SmithRich HTML message body.
\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"attachment\"; filename=\"file.zip\"\n \n(data)\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"bulkId\"\n \ncustomBulkId\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"intermediateReport\"\n \ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"defaultPlaceholders\"\n \n{\"ph1\": \"Success\", \"ph2\": \"Example\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"headers\"\n \n{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyUrl\"\n \nhttps://www.example.com/email/advanced\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyContentType\"\n \napplication/json\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackClicks\"\n\ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackOpens\"\n\nfalse\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackingPixelPosition\"\n\nTOP\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"callbackData\"\n \nDLR callback data\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"ipPoolId\"\n\n08A3A7608750CC6E6080325A6ADF45B6\n------WebKitFormBoundary7MA4YWxkTrZu0gW--\n" }, "Send fully featured email using PHP":{ "summary":"Send fully featured email using PHP", "description":"Send fully featured email using PHP", "value":"\nsetUrl('https://{base_url}/email/3/send');\n $request->setMethod(HTTP_Request2::METHOD_POST);\n $request->setConfig(array(\n 'follow_redirects' => TRUE\n ));\n $request->setHeader(array(\n 'Authorization' => 'Basic {username:password}',\n 'Content-Type' => 'multipart/form-data'\n ));\n \n $request->addPostParameter(array(\n 'from' => 'Jane SmithRich HTML message body.
',\n 'bulkId' => 'customBulkId',\n 'intermediateReport' => 'true',\n 'defaultPlaceholders' => '{\"ph1\": \"Success\", \"ph2\": \"Example\"}'\n 'headers' => '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"HeaderValue\"}'\n 'notifyUrl' => 'https://www.example.com/email/advanced',\n 'notifyContentType' => 'application/json',\n 'trackClicks' => 'true',\n 'trackOpens' => 'false',\n 'trackingPixelPosition' => 'TOP',\n 'callbackData' => 'DLR callback data',\n 'ipPoolId' => '08A3A7608750CC6E6080325A6ADF45B6'\n ));\n \n $request->addUpload('attachment', '/home/files/image.jpg', 'image.jpg', 'Rich HTML message body.
\");\nrequest.AddParameter(\"attachment\", \"@files/image1.jpg\");\nrequest.AddParameter(\"bulkId\", \"customBulkId\");\nrequest.AddParameter(\"intermediateReport\", \"true\");\nrequest.AddParameter(\"defaultPlaceholders\", \"{\"ph1\": \"Success\", \"ph2\": \"Example\"}\")\nrequest.AddParameter(\"headers\", \"{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}\")\nrequest.AddParameter(\"notifyUrl\", \"https://www.example.com/email/advanced\");\nrequest.AddParameter(\"notifyContentType\", \"application/json\");\nrequest.AddParameter(\"trackClicks\", \"true\");\nrequest.AddParameter(\"trackOpens\", \"false\");\nrequest.AddParameter(\"trackingPixelPosition\", \"TOP\");\nrequest.AddParameter(\"callbackData\", \"DLR callback data\");\nrequest.AddParameter(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, "Send fully featured email using JavaScript":{ "summary":"Send fully featured email using JavaScript", "description":"Send fully featured email using JavaScript", "value":"\nconst data = new FormData();\ndata.append(\"from\", \"Jane SmithRich HTML message body.
\");\ndata.append(\"attachment\", \"@files/image1.jpg\");\ndata.append(\"bulkId\", \"customBulkId\");\ndata.append(\"intermediateReport\", \"true\");\ndata.append(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\")\ndata.append(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\")\ndata.append(\"notifyUrl\", \"https://www.example.com/email/advanced\");\ndata.append(\"notifyContentType\", \"application/json\");\ndata.append(\"trackClicks\", \"true\");\ndata.append(\"trackOpens\", \"false\");\ndata.append(\"trackingPixelPosition\", \"TOP\");\ndata.append(\"callbackData\", \"DLR callback data\");\ndata.append(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if (this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://{{baseUrl}}}}/email/3/send\");\nxhr.setRequestHeader(\"Authorization\", \"Basic {username:password}\");\nxhr.send(data);\n" }, "Send fully featured email using Python":{ "summary":"Send fully featured email using Python", "description":"Send fully featured email using Python", "value":"\nimport requests\nimport json\n \nurl = 'https://{base_url}/email/3/send'\nheaders = {'Authorization': 'Basic {username:password}'}\n \nfile = open('files/image1.jpg', 'rb')\nfiles = {'attachment': ('image1.jpg', file)}\n \ndata = {\n 'from': 'Jane SmithRich HTML message body.
',\n 'attachment': '@/files/image1.jpg',\n 'bulkId': 'customBulkId',\n 'intermediateReport': 'true',\n 'defaultPlaceholders': '{\"ph1\": \"Success\", \"ph2\": \"Example\"}',\n 'headers': '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header value\"}',\n 'notifyUrl': 'https://www.example.com/email/advanced',\n 'notifyContentType': 'application/json',\n 'trackClicks': true,\n 'trackOpens': false,\n 'trackingPixelPosition': 'TOP',\n 'callbackData': 'DLR callback data'\n 'ipPoolId': '08A3A7608750CC6E6080325A6ADF45B6'\n}\n\nresponse = requests.post(url, headers=headers, data=data, files=files)\nfile.close()\nprint(response.text)\n" } } } } }, "responses":{ "200":{ "description":"Successful Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse" }, "examples":{ "Example for single message":{ "summary":"Example for single message", "description":"Example for single message", "value":{ "bulkId":"snxemd8u52v7v84iiu69", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for single message with custom ID":{ "summary":"Example for single message with custom ID", "description":"Example for single message with custom ID", "value":{ "bulkId":"customBulkId", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for multiple message":{ "summary":"Example for multiple message", "description":"Example for multiple message", "value":{ "bulkId":"4pk1xihiy4rln2f1g2se", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"tu5k6tdo7df1bpgk7ggs", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } }, { "to":"jane.doe@somecompany.com", "messageId":"e7zzb1v9yirml2se9zo4", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } } } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-additional-throttling-information":{ "Learn more about custom throttling limits":"https://www.infobip.com/docs/api" }, "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)\n- [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)\n- [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)\n" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":4000, "numberOfTimeUnits":0, "timeUnit":"s" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"send-email-messages-api" }, { "versionNumber":3, "latest":false, "operationId":"send-fully-featured-email" } ] } }, "/email/4/mime":{ "post":{ "tags":[ "channels", "email", "email-message-sending" ], "summary":"Send MIME email", "description":"Send an email where you can specify the content as MIME message.", "operationId":"send-mime-email", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema" }, "examples":{ "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.":{ "summary":"Send email with single recipient using MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo0ODoyMyArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF8xNDkzMzcyMS4xNzUwMjQzNzAzMTY0Ig0KWC1JQi1idWxrLWlkOiBkZWZhdWx0QnVsa0lkDQoNCi0tLS0tLT1fUGFydF8wXzE0OTMzNzIxLjE3NTAyNDM3MDMxNjQNCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQ0KQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdA0KDQpIZWxsbyB3b3JsZA0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NA0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NC0tDQo=" } }, "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.":{ "summary":"Send email with multiple recipients using MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company", "mike.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1MTo1NiArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbSwgbWlrZS5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1NyINClgtSUItYnVsay1pZDogZGVmYXVsdEJ1bGtJZA0KDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PXVzLWFzY2lpDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0DQoNCkhlbGxvIHdvcmxkDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfOTQzNzQ5OTAyLjE3NTAyNDM5MTYxNTctLQ0K" } }, "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.":{ "summary":"Send email with multiple recipients using complex MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company", "mike.smith@company", "jenny.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1NTozNiArMDIwMCAoQ0VTVCkKRnJvbTogamVubnkuc21pdGhAY29tcGFueS5jb20KVG86IGpvaG4uc21pdGhAY29tcGFueS5jb20KQ2M6IG1pa2Uuc21pdGhAY29tcGFueS5jb20KQmNjOiBqZW5ueS5zbWl0aEBjb21wYW55Ck1lc3NhZ2UtSUQ6IDxtZXNzYWdlQGlkPgpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QKTUlNRS1WZXJzaW9uOiAxLjAKQ29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7CiBib3VuZGFyeT0iLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0IgpYLUlCLWJ1bGstaWQ6IGRlZmF1bHRCdWxrSWQKCi0tLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0CkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0CgpIZWxsbyB3b3JsZAoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdAoKPGRpdj5IZWxsbyB3b3JsZCA8aW1nIHNyYz0iY2lkOmltYWdlXzEiLz4gPC9kaXY+CgotLS0tLS09X1BhcnRfMF82NTk0OTQ1OTkuMTc1MDI0NDEzNTk4NApDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9dXMtYXNjaWk7IG5hbWU9YXR0YWNobWVudF8xCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LURpc3Bvc2l0aW9uOiBhdHRhY2htZW50OyBmaWxlbmFtZT1hdHRhY2htZW50XzEKClZHaHBjeUJwY3lCaGRIUmhZMmh0Wlc1MElHUmhkR0U9CgoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiBpbWFnZS9qcGVnCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LUlEOiBpbWFnZV8xCgpWR2hwY3lCcGN5QmhkSFJoWTJodFpXNTBJR1JoZEdFPQoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQtLQ==" } } } } } }, "responses":{ "200":{ "description":"Successful Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse" }, "examples":{ "Example for single message":{ "summary":"Example for single message", "description":"Example for single message", "value":{ "bulkId":"snxemd8u52v7v84iiu69", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for single message with custom ID":{ "summary":"Example for single message with custom ID", "description":"Example for single message with custom ID", "value":{ "bulkId":"customBulkId", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for multiple message":{ "summary":"Example for multiple message", "description":"Example for multiple message", "value":{ "bulkId":"4pk1xihiy4rln2f1g2se", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"tu5k6tdo7df1bpgk7ggs", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } }, { "to":"jane.doe@somecompany.com", "messageId":"e7zzb1v9yirml2se9zo4", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } } } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-additional-throttling-information":{ "Learn more about custom throttling limits":"https://www.infobip.com/docs/api" }, "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)\n- [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)\n- [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)\n" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":4000, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/email/1/bulks":{ "get":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Get scheduled bulks", "description":"See the scheduled time of your Email messages.", "operationId":"get-scheduled-emails", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":{ "sendAt":"2025-12-01T15:00:00.000Z" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkScheduleResponse" }, "examples":{ "Get sent email bulks response - single bulk":{ "summary":"Get sent email bulks response - single bulk", "description":"Get sent email bulks response - single bulk", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "sendAt":"2025-12-01T12:00:00.000+0000" } ] } }, "Get sent email bulks response - multiple bulks":{ "summary":"Get sent email bulks response - multiple bulks", "description":"Get sent email bulks response - multiple bulks", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "sendAt":"2025-12-01T12:00:00.000+0000" }, { "bulkId":"2033247207450906898", "sendAt":"2025-12-01T14:00:00.000+0000" }, { "bulkId":"2033247207450906899", "sendAt":"2025-12-01T16:00:00.000+0000" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:message:send" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "put":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Reschedule messages", "description":"Change the date and time for sending scheduled messages.", "operationId":"reschedule-emails", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleRequest" }, "examples":{ "Reschedule email bulk request":{ "summary":"Reschedule email bulk request", "description":"Reschedule email bulk request", "value":{ "sendAt":"2025-12-01T15:00:00.000Z" } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleResponse" }, "examples":{ "Reschedule email bulk response":{ "summary":"Reschedule email bulk response", "description":"Reschedule email bulk response", "value":{ "bulkId":"2033247207450906897", "sendAt":"2025-12-01T15:00:00.000+0000" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"CONFLICT", "text":"Update not allowed for bulk" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/email/1/bulks/status":{ "get":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Get scheduled bulk statuses", "description":"See the status of scheduled email messages.", "operationId":"get-scheduled-email-statuses", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusResponse" }, "examples":{ "Get bulk status response - paused":{ "summary":"Get bulk status response - paused", "description":"Get bulk status response - paused", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "status":"PAUSED" } ] } }, "Get bulk status response - canceled":{ "summary":"Get bulk status response - canceled", "description":"Get bulk status response - canceled", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "status":"CANCELED" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:message:send" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "put":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Update scheduled message statuses", "description":"Change status or completely cancel sending of scheduled messages.", "operationId":"update-scheduled-email-statuses", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusRequest" }, "examples":{ "Update bulk status request - pause":{ "summary":"Update bulk status request - pause", "description":"Update bulk status request - pause", "value":{ "status":"PAUSED" } }, "Update bulk status request - cancel":{ "summary":"Update bulk status request - cancel", "description":"Update bulk status request - cancel", "value":{ "status":"CANCELED" } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusResponse" }, "examples":{ "Update bulk status response - paused":{ "summary":"Update bulk status response - paused", "description":"Update bulk status response - paused", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"PAUSED" } }, "Update bulk status response - canceled":{ "summary":"Update bulk status response - canceled", "description":"Update bulk status response - canceled", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"CANCELED" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"CONFLICT", "text":"Update not allowed for bulk" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/email/4/logs":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.", "operationId":"get-email-message-logs", "parameters":[ { "name":"sender", "in":"query", "description":"The sender ID which can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"destination", "in":"query", "description":"Message destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"BULK-ID-123-xyz" }, { "name":"messageId", "in":"query", "description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz" }, { "name":"generalStatus", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageGeneralStatus" } }, { "name":"sentSince", "in":"query", "description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2020-02-22T17:42:05.390+01:00" }, { "name":"sentUntil", "in":"query", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "example":"2020-02-23T17:42:05.39+01:00" }, "example":"2020-02-23T17:42:05.390+01:00" }, { "name":"limit", "in":"query", "description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 } }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"summersale" }, { "name":"useCursor", "in":"query", "description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"cursor", "in":"query", "description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.LogResponseEmailUnificationLog" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:logs:read" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-email-message-logs" }, { "versionNumber":1, "latest":false, "operationId":"get-email-logs" } ] } }, "/email/4/reports":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email delivery reports", "description":"Get one-time delivery reports for all sent emails.", "externalDocs":{ "description":"Learn more about EMAIL channel and use cases", "url":"https://www.infobip.com/docs/email" }, "operationId":"get-outbound-email-message-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"summersale" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReports" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-outbound-email-message-delivery-reports" }, { "versionNumber":1, "latest":false, "operationId":"get-email-delivery-reports" } ] } }, "/email/1/logs":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email message logs", "description":"This method allows you to get logs for sent emails using their messageId. Email logs are available for the last 48 hours.", "operationId":"get-email-logs", "parameters":[ { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the sent email.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"from", "in":"query", "description":"From email address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"to", "in":"query", "description":"The recipient email address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Bulk ID that uniquely identifies the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"campaignReferenceId", "in":"query", "description":"The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"generalStatus", "in":"query", "description":"Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"sentSince", "in":"query", "description":"Tells when the email was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2021-01-02T01:00:00.123Z" } }, { "name":"sentUntil", "in":"query", "description":"Tells when the email request was processed by Infobip.Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2021-01-02T01:00:00.123Z" } }, { "name":"limit", "in":"query", "description":"Maximum number of logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "maximum":1000 } }, { "name":"applicationId", "in":"query", "description":"[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"entityId", "in":"query", "description":"[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLogResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:logs:read", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":60, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-email-message-logs" }, { "versionNumber":1, "latest":false, "operationId":"get-email-logs" } ] } }, "/email/1/reports":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email delivery reports", "description":"Get one-time delivery reports for all sent emails.", "operationId":"get-email-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"Bulk ID for which report is requested.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the sent email.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"campaignReferenceId", "in":"query", "description":"The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of reports.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "maximum":1000 } }, { "name":"applicationId", "in":"query", "description":"[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"entityId", "in":"query", "description":"[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReportsResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":60, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-outbound-email-message-delivery-reports" }, { "versionNumber":1, "latest":false, "operationId":"get-email-delivery-reports" } ] } }, "/email/2/validation":{ "post":{ "tags":[ "channels", "email", "email-validation" ], "summary":"Validate email address", "description":"This method lets you request validation of a single email address in real-time,\nhelping you to identify and remove poor-quality emails from your list.\n", "operationId":"validate-email-addresses", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "to":"john.smith@example.com" } } } }, "application/x-www-form-urlencoded":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":"curl -s --user user:password https://{base_url}/email/2/validation --data-urlencode 'to=john.smith@example.com'" } } } } }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse" }, "examples":{ "Valid email box response":{ "summary":"Valid email box response", "description":"Valid email box response", "value":{ "to":"john.smith@example.com", "validMailbox":"true", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "risk":"LOW" } }, "Invalid email box response":{ "summary":"Invalid email box response", "description":"Invalid email box response", "value":{ "to":"jane.smith@example.com", "validMailbox":"false", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "detailedReasons":"known_hardbounce", "risk":"HIGH" } }, "Mailbox is unknown response":{ "summary":"Mailbox is unknown response", "description":"Mailbox is unknown response", "value":{ "to":"john.doe@example.org", "validMailbox":"unknown", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "reason":"INBOX_FULL", "detailedReasons":"mailbox_full", "risk":"HIGH" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse" }, "examples":{ "Valid email box response":{ "summary":"Valid email box response", "description":"Valid email box response", "value":"