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.

Expire inbox

Prev Next
Post
/expire/inbox-campaign

Used to expire an entire inbox campaign that is currently live

Body parameters
Expire an inbox campaign
{
  "apptoken": "YOUR-APPTOKEN",
  "campaign_id": "123456"
}
object
apptoken
string Required

Your App token

campaign_id
integer (int32) Required

The ID of the inbox campaign you want to expire

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"
}
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