POST api/v1/Message

Create and send a message to one individual. This should be used for emails that need to be sent immediately and cannot wait to be picked up on a schedule (i.e. password resets, email confirmations, etc.)

Request Information

URI Parameters

None.

Body Parameters

MessageModel

Name	Type	Additional information
SenderId	integer	None.
EmailMessage	string	None.
EmailToAddress	string	None.
EmailIsHTML	boolean	None.
EmailSubject	string	None.
EntityNameId	byte	None.
EntityId	integer	None.
SendEmail	boolean	None.
SendSMS	boolean	None.
SMSMessage	string	None.
SMSToNumber	string	None.
TrackOpens	boolean	None.
TrackClicks	boolean	None.
TrackSubscriptions	boolean	None.
TemplateId	string	None.
Substitutions	Collection of Dictionary of string [key] and string [value]	None.
Attachments	Collection of EmailAttachmentModel	None.

Request Formats

application/json, text/json

Sample:

{
  "senderId": 1,
  "emailMessage": "sample string 2",
  "emailToAddress": "sample string 3",
  "emailIsHTML": true,
  "emailSubject": "sample string 5",
  "entityNameId": 64,
  "entityId": 7,
  "sendEmail": true,
  "sendSMS": true,
  "smsMessage": "sample string 10",
  "smsToNumber": "sample string 11",
  "trackOpens": true,
  "trackClicks": true,
  "trackSubscriptions": true,
  "templateId": "sample string 15",
  "substitutions": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ],
  "attachments": [
    {
      "filename": "sample string 1",
      "dataBytes": "QEA="
    },
    {
      "filename": "sample string 1",
      "dataBytes": "QEA="
    }
  ]
}

text/html

Sample:

{"senderId":1,"emailMessage":"sample string 2","emailToAddress":"sample string 3","emailIsHTML":true,"emailSubject":"sample string 5","entityNameId":64,"entityId":7,"sendEmail":true,"sendSMS":true,"smsMessage":"sample string 10","smsToNumber":"sample string 11","trackOpens":true,"trackClicks":true,"trackSubscriptions":true,"templateId":"sample string 15","substitutions":[{"sample string 1":"sample string 2","sample string 3":"sample string 4"},{"sample string 1":"sample string 2","sample string 3":"sample string 4"}],"attachments":[{"filename":"sample string 1","dataBytes":"QEA="},{"filename":"sample string 1","dataBytes":"QEA="}]}

application/xml, text/xml

Sample:

<MessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Switchboard.Entities.Models">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Switchboard.Models">
    <d2p1:EmailAttachmentModel>
      <d2p1:DataBytes>QEA=</d2p1:DataBytes>
      <d2p1:Filename>sample string 1</d2p1:Filename>
    </d2p1:EmailAttachmentModel>
    <d2p1:EmailAttachmentModel>
      <d2p1:DataBytes>QEA=</d2p1:DataBytes>
      <d2p1:Filename>sample string 1</d2p1:Filename>
    </d2p1:EmailAttachmentModel>
  </Attachments>
  <EmailIsHTML>true</EmailIsHTML>
  <EmailMessage>sample string 2</EmailMessage>
  <EmailSubject>sample string 5</EmailSubject>
  <EmailToAddress>sample string 3</EmailToAddress>
  <EntityId>7</EntityId>
  <EntityNameId>64</EntityNameId>
  <SMSMessage>sample string 10</SMSMessage>
  <SMSToNumber>sample string 11</SMSToNumber>
  <SendEmail>true</SendEmail>
  <SendSMS>true</SendSMS>
  <SenderId>1</SenderId>
  <Substitutions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <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>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <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>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </Substitutions>
  <TemplateId>sample string 15</TemplateId>
  <TrackClicks>true</TrackClicks>
  <TrackOpens>true</TrackOpens>
  <TrackSubscriptions>true</TrackSubscriptions>
</MessageModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MessageModel'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.