Send Message
POST {{baseUrl}}/messages/?attachment=<>&bcc=<>&cc=<>&from=<>&h:X-My-Header=<>&html=<>&inline=<>&o:campaign=<>&o:deliverytime=<>&o:dkim=<>&o:tag=<>&o:testmode=<>&o:tracking=<>&o:tracking-clicks=<>&o:tracking-opens=<>&subject=<>&text=<>&to=<>&v:my-var=<>
Sends a message by assembling it from the components. Note that you can specify most parameters multiple times, HTTP supports this out of the box. This makes sense for parameters like cc, to or attachment.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
attachment | string | File attachment. You can post multiple attachmentnvalues. Important: You must use multipart/form-datanencoding when sending attachments. | |
bcc | string | Same as To but for Bcc | |
cc | string | Same as To but for Cc | |
from | string | Email address for From header | |
h:X-My-Header | string | h: prefix followed by an arbitrary value allows to appendna custom MIME header to the message (X-My-Headernin this case). For example, h:Reply-To to specify Reply-Tonaddress. | |
html | string | Body of the message. (HTML version) | |
inline | string | Attachment with inline disposition. Can be used tonsend inline images (see example).nYou can post multiple inline values. | |
o:campaign | string | Id of the campaign the message belongs to. SeenCampaign Analytics for details. | |
o:deliverytime | string | Desired time of delivery. See Date Format. Note:nMessages can be scheduled for a maximum of 3 days in thenfuture. | |
o:dkim | string | Enables/disabled DKIM signatures on per-message basis.nPass yes or no | |
o:tag | string | Tag string. See Tagging for more information. | |
o:testmode | string | Enables sending in test mode. Pass yes if needed.nSee Sending in Test Mode | |
o:tracking | string | Toggles tracking on a per-message basis, seenTracking Messages for details. Pass yes or no. | |
o:tracking-clicks | string | Toggles clicks tracking on a per-message basis. Has highernpriority than domain-level setting. Pass yes, nonor htmlonly. | |
o:tracking-opens | string | Toggles opens tracking on a per-message basis. Has highernpriority than domain-level setting. Pass yes or no. | |
subject | string | Message subject | |
text | string | Body of the message. (text version) | |
to | string | Email address of the recipient(s).nExample: "Bob <bob@host.com>". You can use commas tonseparate multiple recipients.nMake sure to include all To, Cc and Bccnrecipients of the message. | |
v:my-var | string | v: prefix followed by an arbitrary name allows tonattach a custom JSON data to the message.nSee Attaching Data to Messages for more information. |