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.

Info

Prev Next
Post
/info/campaign

Used to get info on a single campaign.

Review the campaign model properties page to see the available parameters.

Body parameters
object
apptoken
string Required

Your App Token

id
string Required

The id of the campaign you are looking for

select
Array of string

Select what params to return, eg. ["id", "title", "text", "labels"]

string
Responses
200

200

Result
{
  "code": "200",
  "success": "True",
  "model": {
    "active": "1",
    "text": "Beacon Entry Test",
    "title": "Add location via API test",
    "labels": [
      {
        "id": "637",
        "name": "Tests"
      }
    ]
  }
}
Expand All
object
code
integer
Default0
Example200
success
boolean
Defaulttrue
ExampleTrue
model
object
active
integer
Default0
Example1
text
string
ExampleBeacon Entry Test
title
string
ExampleAdd location via API test
labels
Array of object
object
id
integer
Default0
Example637
name
string
ExampleTests
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