This API is used to set the status of the campaign to start or stop. The action parameter MUST be "Start" to start the campaign or "Stop" to stop the campaign.

To use this API with the help of a token, follow these steps:

Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
With the token entered, pass the below header and body parameters:

Header parameters

Parameter	Description
Content-Type	application/json

Body Params

{
"userName": "xxxxx",
"campaignName": "xxxxx",
"action": "Stop",
"process": true
}

Parameter	Description
userName*	Your CloudAgent account username
campaignName*	Name of the campaign, as configured in the CloudAgent account.
action*	"Start" to start the campaign. "Stop" to stop the campaign.
process*	Should be - true

Possible Responses


Success response (campaign started)	"status": "SUCCESS" "message": "SUCCESSFULLY UPDATED, Progressive was started"}
Success response (campaign stopped)	"status": "SUCCESS" "message": "SUCCESSFULLY UPDATED, Progressive was stopped"
Error	"status": "failure" "message": "All parameters are mandatory"