POST api/Mailing

Request Information

URI Parameters

None.

Body Parameters

Mail
NameDescriptionTypeAdditional information
IsBodyHtml

boolean

None.

Body

string

None.

Subject

string

None.

From

string

None.

DisplayName

string

None.

Priority

MailPriority

None.

To

Collection of string

None.

CC

Collection of string

None.

BCC

Collection of string

None.

ReplyTo

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "IsBodyHtml": true,
  "Body": "sample string 2",
  "Subject": "sample string 3",
  "From": "sample string 4",
  "DisplayName": "sample string 5",
  "Priority": 0,
  "To": [
    "sample string 1",
    "sample string 2"
  ],
  "CC": [
    "sample string 1",
    "sample string 2"
  ],
  "BCC": [
    "sample string 1",
    "sample string 2"
  ],
  "ReplyTo": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ApiMailingViewModel.Mail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <BCC xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BCC>
  <Body>sample string 2</Body>
  <CC xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CC>
  <DisplayName>sample string 5</DisplayName>
  <From>sample string 4</From>
  <IsBodyHtml>true</IsBodyHtml>
  <Priority>Normal</Priority>
  <ReplyTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReplyTo>
  <Subject>sample string 3</Subject>
  <To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </To>
</ApiMailingViewModel.Mail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AttemptResponse
NameDescriptionTypeAdditional information
Type

Attempt_ResponseTypes

None.

Exception

Exception

None.

ObjectID

Object

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Type": 0,
  "Exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  },
  "ObjectID": {},
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<AttemptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.Utils">
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <ObjectID />
  <Type>Warning</Type>
</AttemptResponse>