Send a Message

This method sends a message to a given recipient(s) from the user associated with the session key. A session key must be submitted via the X-Session-Key header. A successful transaction will receive a 200 status code.

Body Params

Send message message data

To
array of strings
required

An array of recipients of the email message

To*
string

Sender's email address

Cc
array of strings

An array of recipients carbon copied on the email message

Cc
Bcc
array of strings

An array of recipients blind carbon copied on the email message

Bcc
string

The subject line of the email message

string

Date/Time string for when message is created

Attachments
array of objects

An array of attachments

Attachments
string

The HTML body of the email message

string

The text body of the email message

string

The name of the custom notification template

string

The custom ID for use with the CRM

Headers
string
Responses

400

The SendMessageMessageData model is required in the request body. || The To field is required. || The Subject exceeds maximum length. An invalid Content Id was provided on an attachment.

401

The X-Session-Key header is missing. || Bad session key. || Session key expired. || Recipient Invalid - To recipient is [ToEmailAddress]. || Recipient Invalid - Cc recipient is [CcEmailAddress]. || Recipient Invalid - Bcc recipient is [BccEmailAddress]. || File sizes greater than 32 MB are not supported. || Message not sent because you do not have permission to send or the email address is incorrectly formed for one or more of the recipients specified. || At least one recipient must be specified. || The custom notification template '{template name}' was not found. || The CRM Custom ID exceeds maximum length.

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json