Publish a Campaign

Use publish to be able to run a campaign or make it available for scheduling 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”: “publish”

}

Response code 200 returns a boolean value of true indicating that the campaign is published successfully.

true

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

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

Response code 404 returns a message of not found if the campaign Id is wrong in the parameter.

Response code 422 returns a message that the required parameters are missing, or if the action field is missing, empty, or invalid.

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

Response code 500 returns an error when an unknown internal server error occurs.

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