{"info":{"_postman_id":"67f5c576-87bb-4a82-ae85-357286056eea","name":"Sendclean API Docs","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"23753314","collectionId":"67f5c576-87bb-4a82-ae85-357286056eea","publishedId":"2s83zgt4tv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-10-07T11:54:22.000Z"},"item":[{"name":"Mail","item":[{"name":"Sending a single email to a single recipient","id":"c4a13480-1dd7-409b-9837-e00967452b59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"recipient@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"c4a13480-1dd7-409b-9837-e00967452b59"},{"name":"Sending the same email to multiple recipients","id":"0671df5d-1890-4ac2-8032-34259cf38cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"recipient1@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient2@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient3@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0671df5d-1890-4ac2-8032-34259cf38cd8"},{"name":"Sending multiple emails from multiple senders to multiple recipients","id":"e907d7af-2fa6-4ac1-a992-8e1428a56d04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": {\n \"email\": \"default@samedomain.com\",\n \"name\" : \"Example name\"\n },\n \"personalizations\": [\n {\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\",\n \"to\": [\n {\n \"email\": \"recipient1@example1.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"from\": {\n \"email\": \"sender1@samedomain.com\",\n \"name\" : \"Example name\"\n }\n },\n {\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\",\n \"to\": [\n {\n \"email\": \"recipient2@example2.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"from\": {\n \"email\": \"sender2@samedomain.com\",\n \"name\" : \"Example name\"\n }\n },\n {\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\",\n \"to\": [\n {\n \"email\": \"recipient3@example3.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"from\": {\n \"email\": \"sender3@samedomain.com\",\n \"name\" : \"Example name\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"e907d7af-2fa6-4ac1-a992-8e1428a56d04"},{"name":"Sending two different emails to two different groups of recipients","id":"99ad7119-4b9f-4019-b5b8-50f4fd0c16a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"recipient1@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"recipient2@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient3@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient4@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\"\n },\n {\n \"to\": [\n {\n \"email\": \"recipient5@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"recipient6@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient7@example.com\",\n \"name\" : \"Example name\"\n },\n {\n \"email\": \"recipient8@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"99ad7119-4b9f-4019-b5b8-50f4fd0c16a0"},{"name":"Sending a single email to a single recipient with a CC","id":"8b00662f-9aff-4715-8ad8-b396822001ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"recipient1@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"recipient2@example.com\",\n \"name\" : \"Example name\"\n }\n ],\n \"subject\": \"YOUR SUBJECT LINE GOES HERE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8b00662f-9aff-4715-8ad8-b396822001ac"},{"name":"Bulk Mail Body","id":"752c86d2-9d4e-48c6-b515-8aa02db49078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"john_doe@example.com\",\n \"name\": \"John Doe\"\n },\n {\n \"email\": \"julia_doe@example.com\",\n \"name\": \"Julia Doe\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"jane_doe@example.com\",\n \"name\": \"Jane Doe\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"james_doe@example.com\",\n \"name\": \"Jim Doe\"\n }\n ]\n },\n {\n \"from\": {\n \"email\": \"sales@example.com\",\n \"name\": \"Example Sales Team\"\n },\n \"to\": [\n {\n \"email\": \"janice_doe@example.com\",\n \"name\": \"Janice Doe\"\n }\n ],\n \"subject\": \"Welcome to -first_name- -last_name-\",\n \"substitutions\": {\n \"-first_name-\": \"Janice\",\n \"-last_name-\": \"Doe\"\n },\n \"bcc\": [\n {\n \"email\": \"jordan_doe@example.com\",\n \"name\": \"Jordan Doe\"\n }\n ]\n }\n ],\n \"from\": {\n \"email\": \"orders@example.com\",\n \"name\": \"Example Order Confirmation\"\n },\n \"reply_to\": {\n \"email\": \"customer_service@example.com\",\n \"name\": \"Example Customer Service Team\"\n },\n \"subject\": \"Your Example Order Confirmation\",\n \"content\": [\n {\n \"type\": \"text/html\",\n \"value\": \"

Hello from Sendclean!

Sending with the email service trusted by developers and marketers for time-savings, scalability, and delivery expertise.

%open-track%

Personalizations (required) array[object] An array of messages and their metadata. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled. MaxItems: 1000

from (required) object email string The 'From' email address used to deliver the message. This address should be a verified sender in your sendclean account. format: email name string A name or title associated with the sending email address.

to array[object] email string The intended recipient's email address. format: email name string The intended recipient's name.

cc array[object]

email string The intended recipient's email address. format: email name string The intended recipient's name.

bcc array[object] email string The intended recipient's email address. format: email name string The intended recipient's name.

subject string The subject of your email. See character length requirements according to from (required) object email string The 'From' email address used to deliver the message. This address should be a verified sender in your sendclean account. format: email name string A name or title associated with the sending email address.

reply_to (required) object email string The email address where any replies or bounces will be returned. format: email

name string A name or title associated with the reply_to email address.

Content (required) array[object] An array where you can specify the content of your email. You can include multiple MIME types of content, but you must specify MIME type.

type string The MIME type of the content you are including in your email (e.g. \"text/html\"). value string The actual content of the specified MIME type that you are including in your email.

attachments array[object] An array of objects where you can specify any attachments you want to include. Content string The Base64 encoded content of the attachment. MinLength: 1

type string The MIME type of the content you are attaching (e.g. text/plain). minLength: 1 filename string The attachment's filename. disposition string The attachment's content-disposition, specifying how you would like the attachment to be displayed. For example inline,results in the attached file are displayed automatically within the message while attachment results in the attached file require some action to be taken before it is displayed, such as opening or downloading the file. default: attachmentAllowed Values: inline, attachment

headers object An object containing key/value pairs of header names and the value to substitute for them. The key/value pairs must be strings. You must ensure these are properly encoded if they contain unicode characters. These headers cannot be one of the reserved headers

\n","urlObject":{"protocol":"https","path":["v2","mail","send"],"host":["api","us1-mta1","sendclean","net"],"query":[],"variable":[]}},"response":[{"id":"63874624-8c92-4598-8d3b-2a4374695244","name":"Bulk Mail Body","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\n \"personalizations\": [\n {\n \"to\": [\n {\n \"email\": \"john_doe@example.com\",\n \"name\": \"John Doe\"\n },\n {\n \"email\": \"julia_doe@example.com\",\n \"name\": \"Julia Doe\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"jane_doe@example.com\",\n \"name\": \"Jane Doe\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"james_doe@example.com\",\n \"name\": \"Jim Doe\"\n }\n ]\n },\n {\n \"from\": {\n \"email\": \"sales@example.com\",\n \"name\": \"Example Sales Team\"\n },\n \"to\": [\n {\n \"email\": \"janice_doe@example.com\",\n \"name\": \"Janice Doe\"\n }\n ],\n \"subject\": \"Welcome to -first_name- -last_name-\",\n \"substitutions\": {\n \"-first_name-\": \"Janice\",\n \"-last_name-\": \"Doe\"\n },\n \"bcc\": [\n {\n \"email\": \"jordan_doe@example.com\",\n \"name\": \"Jordan Doe\"\n }\n ]\n }\n ],\n \"from\": {\n \"email\": \"orders@example.com\",\n \"name\": \"Example Order Confirmation\"\n },\n \"reply_to\": {\n \"email\": \"customer_service@example.com\",\n \"name\": \"Example Customer Service Team\"\n },\n \"subject\": \"Your Example Order Confirmation\",\n \"content\": [\n {\n \"type\": \"text/html\",\n \"value\": \"

Hello from Sendclean!

Sending with the email service trusted by developers and marketers for time-savings, scalability, and delivery expertise.

%open-track%

\"\n }\n ],\n \"attachments\": [\n {\n \"content\": \"sad\",\n \"filename\": \"index.html\",\n \"type\": \"text/html\",\n \"disposition\": \"attachment\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.us1-mta1.sendclean.net/v2/mail/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Sarv"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PATCH, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"ETag","value":"W/\"3b-SmmZnM+cyKnnh6v+n7zN0jQ3GDU\""},{"key":"Date","value":"Wed, 17 Aug 2022 10:25:58 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Mail has been send to queued\"\n}"}],"_postman_id":"752c86d2-9d4e-48c6-b515-8aa02db49078"}],"id":"54bd8b41-8fc9-45e0-8810-c828feb14cb4","_postman_id":"54bd8b41-8fc9-45e0-8810-c828feb14cb4","description":""},{"name":"Webhook calls","item":[{"name":"v2/settings/addWebhook","id":"fb496919-df89-4b7c-807e-634bf099e675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\",\r\n \"url\":\"example url\",\r\n \"event\":\"send,open,click,soft_bounce,hard_bounce,spam\",\r\n \"description\":\"description about url\",\r\n \"store_log\":\"Enable\",\r\n \"isNewProcess\": \"Y\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/addWebhook","description":"

Add a new webhook

owner_id : a valid SendCleanUser Id

url: a valid url ,that always response 'God bless you, SendClean'

event: a valid events string with comma separated like 'send,open,click,soft_bounce,hard_bounce,spam,delivered,unsubscribed,suppression'

description: description about webhook

store_log: value is Either 'Enable' OR 'Disable'

isNewProcess: value is either 'Y' or 'N'

\n","urlObject":{"protocol":"https","path":["v2","settings","addWebhook"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb496919-df89-4b7c-807e-634bf099e675"},{"name":"v2/settings/editWebhook","id":"5aa4f503-b62c-4326-98b6-e1594f64b1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\",\r\n \"url\": \"example url\",\r\n \"webhook_id\":\"424353445757557577457\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/editWebhook","description":"

Edit webhook

\n","urlObject":{"protocol":"https","path":["v2","settings","editWebhook"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"5aa4f503-b62c-4326-98b6-e1594f64b1e2"},{"name":"v2/settings/keyResetWebhook","id":"753b84a2-c728-4bda-aa39-27d81a6345d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\",\r\n \"webhook_id\":\"424353445757557577457\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/keyResetWebhook","description":"

Key Reset for Webhook

\n","urlObject":{"protocol":"https","path":["v2","settings","keyResetWebhook"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"753b84a2-c728-4bda-aa39-27d81a6345d4"},{"name":"v2/settings/listWebhook","id":"e696edf8-dc5d-40ea-92c4-ffcf9d4bc46b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/listWebhook","description":"

List webhooks

\n","urlObject":{"protocol":"https","path":["v2","settings","listWebhook"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"e696edf8-dc5d-40ea-92c4-ffcf9d4bc46b"},{"name":"v2/settings/deleteWebhook","id":"fcf4c837-66b4-4158-aaf7-d4e5ebb3c1d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\",\r\n \"webhook_id\":\"424353445757557577457\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/deleteWebhook","description":"

Delete Webhook

\n","urlObject":{"protocol":"https","path":["v2","settings","deleteWebhook"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"fcf4c837-66b4-4158-aaf7-d4e5ebb3c1d9"},{"name":"v2/settings/getWebhookInfo","id":"4f5a702d-dd9a-4110-9a65-196c6f48adb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"<>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"owner_id\":\"example id\",\r\n \"webhook_id\":\"424353445757557577457\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.SendCleanTES_APP_DOMAIN/v2/settings/getWebhookInfo","description":"

Get info of webhook

\n","urlObject":{"protocol":"https","path":["v2","settings","getWebhookInfo"],"host":["api","SendCleanTES_APP_DOMAIN"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f5a702d-dd9a-4110-9a65-196c6f48adb5"}],"id":"f58a0624-a7c4-49ba-8d2f-484fdcbc5d89","_postman_id":"f58a0624-a7c4-49ba-8d2f-484fdcbc5d89","description":""}]}