POST api/communication/campaign/sendtest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Campaign	Campaign	None.
ExcludePersonIds	Collection of integer	None.
TestRecipients	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Campaign": null,
  "ExcludePersonIds": [
    1,
    2
  ],
  "TestRecipients": "sample string 1"
}

application/javascript

Sample:

{"Campaign":null,"ExcludePersonIds":[1,2],"TestRecipients":"sample string 1"}

application/xml, text/xml

Sample:

<CampaignSendRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ExcludePersonIds>
    <int>1</int>
    <int>2</int>
  </ExcludePersonIds>
  <TestRecipients>sample string 1</TestRecipients>
</CampaignSendRequest>

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

Response Information

Resource Description

WebMethodResultOfSendEmailsResponse

Name	Type	Additional information
Result	SendEmailsResponse	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Message": "sample string 1",
    "SuccessCount": 2,
    "ErrorCount": 3,
    "ExcludeCount": 4
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"Message":"sample string 1","SuccessCount":2,"ErrorCount":3,"ExcludeCount":4},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfSendEmailsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Message>sample string 1</Message>
    <SuccessCount>2</SuccessCount>
    <ErrorCount>3</ErrorCount>
    <ExcludeCount>4</ExcludeCount>
  </Result>
</WebMethodResultOfSendEmailsResponse>