POST api/Email/AddToQueue

Adds an email to the sending queue.

Request Information

URI Parameters

None.

Body Parameters

AddToQueueRequest
NameDescriptionTypeAdditional information
Subject

The email subject.

 string

Required
Body

The email body. HTML.

 string

Required
ClientSystemId

The client system ID on behalf this email is being sent.

 globally unique identifier

Required
ToAddresses

The To addresses. Comma-delimited. Optional. If not provided, the default for the email sender profile is used.

 string

None.
CcAddresses

CC addresses. Comma-delimited. Optional.

 string

None.
BccAddresses

BCC addresses. Comma-delimited. Optional.

 string

None.
ReplyToAddresses

Reply-To addresses. Comma-delimited. Optional.

 string

None.
MergeFieldsToValues

MergeField => Value

 Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "ClientSystemId": "4fb195e8-6f66-46db-b1d1-066a6456bdf9",
  "ToAddresses": "sample string 4",
  "CcAddresses": "sample string 5",
  "BccAddresses": "sample string 6",
  "ReplyToAddresses": "sample string 7",
  "MergeFieldsToValues": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

text/xml

Sample: 
<AddToQueueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.EmailTemplate">
  <BccAddresses>sample string 6</BccAddresses>
  <CcAddresses>sample string 5</CcAddresses>
  <MergeFieldsToValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MergeFieldsToValues>
  <ReplyToAddresses>sample string 7</ReplyToAddresses>
  <ToAddresses>sample string 4</ToAddresses>
  <Body>sample string 2</Body>
  <ClientSystemId>4fb195e8-6f66-46db-b1d1-066a6456bdf9</ClientSystemId>
  <Subject>sample string 1</Subject>
</AddToQueueRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample: 
true

text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>