Run a Campaign

Use run to conduct a campaign in Engage.

Note: A campaign can only be run via API if it is in Published status.

 

Endpoint and Methods
  • POST /_rest/v2/campaigns/:id/action

 

Parameters

  • Campaign Id

 

Body

{

“action”: “run”

}

Response code 200 returns a boolean value of true indicating that the campaign is running or has run.

 

true

Response code 401 returns an error that the authorization token is invalid.

 

{
"message": "string",
"status": 401
}

Response code 422 returns a message that the id parameter is required.

 

{  
"message": "The 'id' parameter is required",
  "status": 422
}

Response code 500 returns an error when trying to run the campaign.

 

{
"message": "Something went wrong when trying to run the campaign",
"status": 500
}