POST api/communication/campaign/v2/send
Request Information
URI Parameters
None.
Body Parameters
CampaignSendRequestName | Description | 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:
Response Information
Resource Description
WebMethodResultOfCampaignName | Description | Type | Additional information |
---|---|---|---|
Result | Campaign |
None. |
|
Success | boolean |
None. |
|
ErrorText | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": null, "Success": true, "ErrorText": "sample string 2" }
application/javascript
Sample:
{"Result":null,"Success":true,"ErrorText":"sample string 2"}
application/xml, text/xml
Sample:
<WebMethodResultOfCampaign 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> </WebMethodResultOfCampaign>