Send a new message.

HTTP Status Code 400 Error Codes (error property):

InvalidRequest - The request is invalid (the provided message provides further detail).

RecipientNotSpecified - At least one value, in the To field, was not specified (required).

SubjectExceedsMaximumLength - The subject is too long. The maximum length is 255.

InvalidAttachmentContentId - All contentId field values, of inline attachments, must contain an @ symbol.

CrmCustomIdExceedsMaximumLength - The attributes->crmCustomId value is too long. The maximum length is 255.

HTTP Status Code 401 Error Codes (error property):

Unauthorized - An Authorization token was not provided and is required.

AccessTokenInvalid - The access token is expired or invalid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A message.

attachments
array of objects

A collection of attachments.

attachments
bcc
array of strings

An collection of recipients blind carbon copied on the email message.

bcc
cc
array of strings

An collection of recipients carbon copied on the email message.

cc
string

The HTML body of the email message.

string

The subject line of the email message.

string

The text body of the email message.

to
array of strings

A collection of recipients of the email message.

to
string

The name of the custom notification template.

attributes
object

Other attributes associated with this message.

crmCustomId: A custom id for use with a CRM.

Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json