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.

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

❗️

Note

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 https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.

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