Email API

{
    "channel": "email", //Mandatory. channel used for messaging.
    "from": "{{fromEmailAddress}}", //Mandatory. Email id of the sender.
    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ], //Mandatory. email id of the recipients
            "substitutions": { //Optional. 
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            },
            "correlationId": "" //Optional. The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
        }
    ],
    "substitutions": { //Optional. 
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}"
    },
    "cc": [], //Optional. Email id of the copied recipients.
    "bcc": [], //Optional. Email id of the bcc recipients.
    "multipleToRecipients": true, //Optional. If this parameter is not included then the same email is sent individually to each of the email addresses specified in 'to' field including all cc and bcc email ids.
    "options": { //Optional.
        "fromName": "{{emailSendername}}" //Optional. A string that will appear next to the from address in most email inboxes
    },
    "content": {
        "type": "text", //Mandatory. Either text or html. Use text while sending text emails.
        "subject": "{{subject}}", //Mandatory. Subject of the email
        "replyTo": "{{replyToEmailAddress}}", //Optional. Reply path for the email when the customer responds
        "text": "Simple text content" //Mandatory. Text content of the email
    },
    "requestedReceipts": [ //Optional.
        "submitted",
        "delivered",
        "read",
        "clicked",
        "bounced",
        "not verified",
        "invalid",
        "complaint",
        "failed"
    ], //JSON array that can filter message delivery web-hooks to the notifyURL. Can contain one or more of the following: "submitted", "delivered", "not verified", "invalid", "bounced", "complaint", "read", "clicked", "failed". Check Outbound Webhooks for more information on receipts. Note: All the above receipts are relevant for email via AWS SES. For email via SMTP, only "submitted" receipt is applicable
    "callbackData": "", //Optional. Data that you have configured to receive on the notify Url. This is configured as a part of the request.
    "notifyUrl": "", //Optional. Provide a URL to get notifications on message delivery status. Use requestedReceipts block to specify list of messages status you want to track.
    "contactPolicy": { //Optional. 
        "contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
        "channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
        "channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
    }
}

{
    "channel": "email", //Mandatory. channel used for messaging.
    "from": "{{fromEmailAddress}}", //Mandatory. Email id of the sender.
    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ], //Mandatory. email id of the recipients
            "substitutions": { //Optional.
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            },
            "correlationId": "" //Optional. The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
        }
    ],
    "substitutions": { //Optional.
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}"
    },
    "cc": [], //Optional. Email id of the copied recipients.
    "bcc": [], //Optional. Email id of the bcc recipients.
    "options": { //Optional.
        "fromName": "{{emailSendername}}", //Optional. A string that will appear next to the from address in most email inboxes
        "trackClicks": true, //Optional. When enabled, this tracks all links in the HTML body unless a link is tagged as no-track-connect within the anchor tags. Link tracking is supported only for Email app assets configured using AWS SES.
        "trackOpens": true //Optional. When enabled, this tracks opens of the email. Open tracking is supported only for Email app assets configured using AWS SES. 
    },
    "content": {
        "type": "html", //Mandatory. Either text or html. Use html while sending html emails.
        "subject": "{{subject}}", //Mandatory. Subject of the email
        "replyTo": "{{replyToEmailAddress}}", //Optional. Reply path for the email when the customer responds
        "text": "Fallback text in the event the email client does not support HTML emails", //Optional. Text content of the email
        "html": "<a track_enable href=\"http://example.com\">link text</a><footer><a data-mce-href='$(unsubscribe)' href='$(unsubscribe)' target='_blank' rel='noopener'><span st-unsubscribe='' style='text-decoration: none; color: #0088cc;' data-mce-style='text-decoration: none; color: #0088cc;'>unsubscribe</span></a></footer>" //Mandatory. Raw HTML for the email. Up to 350 kbps in size.
    },
    "requestedReceipts": [ //Optional.
        "submitted",
        "delivered",
        "read",
        "clicked",
        "bounced",
        "not verified",
        "invalid",
        "complaint",
        "failed"
    ], //JSON array that can filter message delivery web-hooks to the notifyURL. Can contain one or more of the following: "submitted", "delivered", "not verified", "invalid", "bounced", "complaint", "read", "clicked", "failed". Check Outbound Webhooks for more information on receipts. Note: All the above receipts are relevant for email via AWS SES. For email via SMTP, only "submitted" receipt is applicable
    "callbackData": "", //Optional. Data that you have configured to receive on the notify Url. This is configured as a part of the request.
    "notifyUrl": "", //Optional. Provide a URL to get notifications on message delivery status. Use requestedReceipts block to specify list of messages status you want to track.
    "contactPolicy": { //Optional.
        "contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
        "channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
        "channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
    }
}

{
    "channel": "email", //Mandatory. channel used for messaging.
    "from": "{{fromEmailAddress}}", //Mandatory. Email id of the sender.
    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ], //Mandatory. email id of the recipients
            "substitutions": { //Optional.
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            },
            "correlationId": "" //Optional. The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
        }
    ],
    "substitutions": { //Optional.
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}"
    },
    "options": { //Optional.
        "trackClicks": true, //Optional. When enabled, this tracks all links in the HTML body unless a link is tagged as no-track-connect within the anchor tags. Link tracking is supported only for Email app assets configured using AWS SES.
        "trackOpens": true, //Optional. When enabled, this tracks opens of the email. Open tracking is supported only for Email app assets configured using AWS SES. 
        "fromName": "{{emailSendername}}" //Optional. A string that will appear next to the from address in most email inboxes
    },
    "content": {
        "type": "html", //Mandatory. Either text or html.
        "subject": "{{subject}}", //Mandatory. Subject of the email
        "text": "Fallback text in the event the email client does not support HTML emails", //Text content of the email Note:yes, when type=text optional, when type=html
        "attachments": [
            {
                "mimetype": "image/png", //Mandatory. Supported mimeTpes
                "name": "Flower", //Mandatory. Name of the attachments
                "mediaUrl": "" //Mandatory. Direct URL pointing to the media file. The URL should end with specified file-format.
            }
        ]
    },
    "requestedReceipts": [ //Optional.
        "submitted",
        "delivered",
        "read",
        "clicked",
        "bounced",
        "not verified",
        "invalid",
        "complaint",
        "failed"
    ], //JSON array that can filter message delivery web-hooks to the notifyURL. Can contain one or more of the following: "submitted", "delivered", "not verified", "invalid", "bounced", "complaint", "read", "clicked", "failed". Check Outbound Webhooks for more information on receipts. Note: All the above receipts are relevant for email via AWS SES. For email via SMTP, only "submitted" receipt is applicable
    "callbackData": "", //Optional. Data that you have configured to receive on the notify Url. This is configured as a part of the request.
    "notifyUrl": "", //Optional. Provide a URL to get notifications on message delivery status. Use requestedReceipts block to specify list of messages status you want to track.
    "contactPolicy": { //Optional.
        "contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
        "channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
        "channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
    }
}

{
    "channel": "email", //Mandatory. channel used for messaging.
    "from": "{{fromEmailAddress}}", //Mandatory. Email id of the sender.
    "to": [
        {
            "email": [
                "{{toEmailAddress}}"
            ], //Mandatory. email id of the recipients
            "substitutions": { //Optional.
                "{{param1}}": "{{param1Value}}",
                "{{param2}}": "{{param2Value}}"
            },
            "correlationId": "" //Optional. The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
        }
    ],
    "substitutions": { //Optional.
        "{{param3}}": "{{param3Value}}",
        "{{param4}}": "{{param4Value}}",
        "{{param5}}": "{{param5Value}}",
        "{{param6}}": "{{param6Value}}"
    },
    "template": {
        "id": "{{templateId}}", //Mandatory. Unique identifier of the email template used for constructing the email
        "subject": "{{subject}}" //Mandatory. Subject of the email
    },
    "requestedReceipts": [ //Optional.
        "submitted",
        "delivered",
        "read",
        "clicked",
        "bounced",
        "not verified",
        "invalid",
        "complaint",
        "failed"
    ], //JSON array that can filter message delivery web-hooks to the notifyURL. Can contain one or more of the following: "submitted", "delivered", "not verified", "invalid", "bounced", "complaint", "read", "clicked", "failed". Check Outbound Webhooks for more information on receipts. Note: All the above receipts are relevant for email via AWS SES. For email via SMTP, only "submitted" receipt is applicable
    "callbackData": "", //Optional. Data that you have configured to receive on the notify Url. This is configured as a part of the request.
    "notifyUrl": "", //Optional. Provide a URL to get notifications on message delivery status. Use requestedReceipts block to specify list of messages status you want to track.
    "contactPolicy": { //Optional.
        "contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
        "channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
        "channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true” 
    }
}

{
    "requestTimestamp": "2024-09-05T00:03:01.708-04:00",
    "messageId": "a770f205-1234-3x5x-x5x3-6dc3e388b9b5",
    "correlationId": "12345",
    "status": "queued"
}

   {
        "code": "7000",
        "message": "Invalid JSON"
    }

No response body