Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v72
  • v74
  • v73
  • v72
Login
  • User API documentation
  • API interaction
  • Matching
  • Profiles
  • Databases
  • Resources
  • Segments
  • Static segments
  • Suppression lists
  • Templates and fragments
  • Campaigns
    • Activate campaign
    • Deactivate campaign
    • Get campaign list
    • Get campaign information
    • Get campaign log
    • Clone campaign
    • Delete campaign
    • Get campaign status
    • Broadcast campaigns
    • Regular campaigns
    • Trigger campaigns
  • Automation scenarios
  • Promo codes
  • Goals
  • Application push notifications
  • Market
  • Analytic reports
  • SendersDevv71
  • External datatables queries
  • Objects
  • Miscellaneous
  • Importing the API collection in Postman
  • List of API endpoints
  • SDK
This is documentation for Altcraft Platform v72. This documentation is no longer maintained.
The information for up-to-date platform version at this page is available (v74).
  • Campaigns
  • Get campaign status
Documentation for version v72

Get campaign status

Description​

Retrieves a campaign status — whether it is active or inactive.

Request URL​

Method: POST

https://example.com/api/v1.1/campaigns/get_status

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
idint12YesCampaign ID

Request example​

  • JSON
  • XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 82
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>82</id>
</xml>

Response example​

  • JSON
  • XML
{
"data": {
"is_active": false,
"is_completed": false,
"status": "Inactive"
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<is_active>false</is_active>
<is_completed>false</is_completed>
<status>"Inactive"</status>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>

Response parameters​

ParameterTypeDescription
errorintError code
error_textstringError text
is_activeboolCampaign active flag
is_completedboolCampaign finished flag
statusstringCurrent campaign status
Last updated on May 29, 2024
Previous
Delete campaign
Next
Broadcast campaigns
  • Description
  • Request URL
  • Request parameters
  • Request example
  • Response example
  • Response parameters
© 2015 - 2025 Altcraft, LLC. All rights reserved.