Emails Test
Emails/Send
Sends an email via SMTP
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Emails/Send

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : EmailSendRequest

Request object type EmailSendRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Attachments Collection of EmailAttachment A collection of objects/files that will be attached to the email.
DuplicateBodyAsAttachment boolean Flag to indicate if the body of the email should be included as a pdf attachment.
DuplicateBodyAttachmentName string Name of the pdf attachment, if DuplicateBodyAsAttachment is true. Defaults to the name 'attachment.pdf'.
EmailProfileId integer Y Email profile to be used to send SMTP email.
FK: TR_EMAIL_PROFILE.id   Resource: EmailProfiles
EmbeddedImages Collection of EmailEmbeddedImage A collection of images that can be referenced to embed images into the HtmlBody using the 'img:cid' tag where 'cid' matches the Name property of the EmbeddedImage to be displayed.
FromAddress string From email address. If not defined, the default for the email profile will be used.
HtmlBody string Html content to be sent. Required if PlainTextBody not defined.
PlainTextBody string Text content to be sent. Required if HtmlBody not defined.
RecipientAddress string Y Email address of recipient. Can be multiple (semi-comma delimited).
Subject string Email subject. If not defined, the default for the email profile will be used. 
{
  "RecipientAddress": "sample string 1",
  "HtmlBody": "sample string 2",
  "PlainTextBody": "sample string 3",
  "FromAddress": "sample string 4",
  "Subject": "sample string 5",
  "DuplicateBodyAsAttachment": true,
  "DuplicateBodyAttachmentName": "sample string 7",
  "EmailProfileId": 8,
  "Attachments": [
    {
      "Name": "sample string 1",
      "AttachmentBytes": "QEA="
    },
    {
      "Name": "sample string 1",
      "AttachmentBytes": "QEA="
    }
  ],
  "EmbeddedImages": [
    {
      "Name": "sample string 1",
      "ImageBytes": "QEA=",
      "MediaType": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "ImageBytes": "QEA=",
      "MediaType": "sample string 2"
    }
  ]
}
<EmailSendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Attachments>
    <EmailAttachment>
      <AttachmentBytes>QEA=</AttachmentBytes>
      <Name>sample string 1</Name>
    </EmailAttachment>
    <EmailAttachment>
      <AttachmentBytes>QEA=</AttachmentBytes>
      <Name>sample string 1</Name>
    </EmailAttachment>
  </Attachments>
  <DuplicateBodyAsAttachment>true</DuplicateBodyAsAttachment>
  <DuplicateBodyAttachmentName>sample string 7</DuplicateBodyAttachmentName>
  <EmailProfileId>8</EmailProfileId>
  <EmbeddedImages>
    <EmailEmbeddedImage>
      <ImageBytes>QEA=</ImageBytes>
      <MediaType>sample string 2</MediaType>
      <Name>sample string 1</Name>
    </EmailEmbeddedImage>
    <EmailEmbeddedImage>
      <ImageBytes>QEA=</ImageBytes>
      <MediaType>sample string 2</MediaType>
      <Name>sample string 1</Name>
    </EmailEmbeddedImage>
  </EmbeddedImages>
  <FromAddress>sample string 4</FromAddress>
  <HtmlBody>sample string 2</HtmlBody>
  <PlainTextBody>sample string 3</PlainTextBody>
  <RecipientAddress>sample string 1</RecipientAddress>
  <Subject>sample string 5</Subject>
</EmailSendRequest>

No response body. Please check http status code header for success (200 OK) or failure. It there are error(s), a collection of ErrorMessages will be returned.

No response body. Please check http status code header for success (200 OK) or failure. It there are error(s), a collection of ErrorMessages will be returned.

Change Version Description Contract Old New
Property Added 15.1.0 DuplicateBodyAsAttachment has been added to EmailSendRequest EmailSendRequest EmailSendRequest.DuplicateBodyAsAttachment
Property Added 15.1.0 DuplicateBodyAttachmentName has been added to EmailSendRequest EmailSendRequest EmailSendRequest.DuplicateBodyAttachmentName