POST api/Campaigns/StopCampaign

Sets the campaign to not launch

Request Information

URI Parameters

None.

Body Parameters

The campaign to launch

CampaignRequest
NameDescriptionTypeAdditional information
SessionToken

string

None.

CampaignID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SessionToken": "sample string 1",
  "CampaignID": 2
}

application/xml, text/xml

Sample:
<CampaignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <CampaignID>2</CampaignID>
  <SessionToken>sample string 1</SessionToken>
</CampaignRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIReturnOfCampaignStatusAndBoolean
NameDescriptionTypeAdditional information
StatusEnum

CampaignStatus

None.

Status

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusEnum": 0,
  "Status": "Success",
  "Result": true
}

application/xml, text/xml

Sample:
<APIReturnOfCampaignStatusbooleanArk7AG5L xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <Result>true</Result>
  <StatusEnum>Success</StatusEnum>
</APIReturnOfCampaignStatusbooleanArk7AG5L>