POST api/SendPortalMail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
To	Collection of string	None.
Cc	Collection of string	None.
Bcc	Collection of string	None.
ReplyTo	string	None.
Subject	string	None.
Type	string	None.
Message	string	None.
LeadId	integer	None.
CustomerId	integer	None.
Attachment	string	None.
FromEmail	string	None.
FromEmailName	string	None.
Images	Collection of ImageVM	None.

Request Formats

application/json, text/json

Sample:

{
  "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",
  "Subject": "sample string 2",
  "Type": "sample string 3",
  "Message": "sample string 4",
  "LeadId": 1,
  "CustomerId": 1,
  "Attachment": "sample string 5",
  "FromEmail": "sample string 6",
  "FromEmailName": "sample string 7",
  "Images": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<SendMailPostVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Mail">
  <Attachment>sample string 5</Attachment>
  <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>
  <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>
  <CustomerId>1</CustomerId>
  <FromEmail>sample string 6</FromEmail>
  <FromEmailName>sample string 7</FromEmailName>
  <Images xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
  </Images>
  <LeadId>1</LeadId>
  <Message>sample string 4</Message>
  <ReplyTo>sample string 1</ReplyTo>
  <Subject>sample string 2</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>
  <Type>sample string 3</Type>
</SendMailPostVm>

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 'SendMailPostVm'.

Response Information

Resource Description

Response

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Description	string	None.
Data	Object	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>