POST api/TestSendGridSingleSend

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
From	string	None.
FromName	string	None.
To	string	None.
Tos	Collection of string	None.
ReplyTo	string	None.
Cc	Collection of string	None.
Bcc	Collection of string	None.
Subject	string	None.
Message	string	None.
TemplateName	string	None.
BroadcastName	string	None.
DocumentUrl	string	None.
DocumentType	string	None.
Images	Collection of ImageVM	None.
NameContactPairs	Collection of NameContactPairVm	None.

Request Formats

application/json, text/json

Sample:

{
  "From": "sample string 1",
  "FromName": "sample string 2",
  "To": "sample string 3",
  "Tos": [
    "sample string 1",
    "sample string 2"
  ],
  "ReplyTo": "sample string 4",
  "Cc": [
    "sample string 1",
    "sample string 2"
  ],
  "Bcc": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 5",
  "Message": "sample string 6",
  "TemplateName": "sample string 7",
  "BroadcastName": "sample string 8",
  "DocumentUrl": "sample string 9",
  "DocumentType": "sample string 10",
  "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"
    }
  ],
  "NameContactPairs": [
    {
      "Name": "sample string 1",
      "DialCode": "sample string 2",
      "Contact": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "DialCode": "sample string 2",
      "Contact": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<BulkNotificationServiceVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Api">
  <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>
  <BroadcastName>sample string 8</BroadcastName>
  <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>
  <DocumentType>sample string 10</DocumentType>
  <DocumentUrl>sample string 9</DocumentUrl>
  <From>sample string 1</From>
  <FromName>sample string 2</FromName>
  <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>
  <Message>sample string 6</Message>
  <NameContactPairs>
    <NameContactPairVm>
      <Contact>sample string 3</Contact>
      <DialCode>sample string 2</DialCode>
      <Name>sample string 1</Name>
    </NameContactPairVm>
    <NameContactPairVm>
      <Contact>sample string 3</Contact>
      <DialCode>sample string 2</DialCode>
      <Name>sample string 1</Name>
    </NameContactPairVm>
  </NameContactPairs>
  <ReplyTo>sample string 4</ReplyTo>
  <Subject>sample string 5</Subject>
  <TemplateName>sample string 7</TemplateName>
  <To>sample string 3</To>
  <Tos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tos>
</BulkNotificationServiceVm>

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

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>