Set Campaign Status

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 access this API the following parameters MUST be passed.

api_key*Available in CloudAgent admin login
campaign_name*Name of the campaign, as configured in the CloudAgent account.
action*"Start" to start the campaign or "Stop" to stop the campaign.



Parameters with ‘*’ are mandatory parameters.

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"


Further Insights

By default, the domain name is Please refer here to change based on the need.

Click Try It! to start a request and see the response here!