Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Start

Prev Next
Post
/start/campaign

Used to start a paused/stopped campaign.

Note: It is not possible to start campaigns in Past status (unless they have been stopped before their configured end time), or to start stopped multi-stage journey campaigns. Learn more.

Body parameters
Start a paused campaign
{
  "apptoken": "YOUR_APPTOKEN",
  "id": "CAMPAIGN_ID"
}
object
apptoken
string Required

Your App token

id
integer (int32) Required

The ID of the campaign you want to start

Responses
200

200

Result
{
  "success": "True",
  "code": "200"
}
object
success
boolean
Defaulttrue
ExampleTrue
code
integer
Default0
Example200
400

400

Result
{
  "success": "False",
  "code": "400",
  "message": "General error information",
  "errors": [
    {
      "text": [
        "Detailed information about the specific error"
      ]
    }
  ]
}
Expand All
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example400
message
string
ExampleGeneral error information
errors
Array of object
object
text
Array of string
string
404

404

Result
{
  "success": "False",
  "code": "404",
  "message": "Not Found"
}
object
success
boolean
Defaulttrue
ExampleFalse
code
integer
Default0
Example404
message
string
ExampleNot Found