POST api/communication/campaign/schedule

Request Information

URI Parameters

None.

Body Parameters

CampaignSendRequest
NameDescriptionTypeAdditional information
Campaign

Campaign

None.

ExcludePersonIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Campaign": null,
  "ExcludePersonIds": [
    1,
    2
  ]
}

application/javascript

Sample:
{"Campaign":null,"ExcludePersonIds":[1,2]}

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>
</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

WebMethodResultOfCampaign
NameDescriptionTypeAdditional 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>