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
    • Get database statistics
    • Update statistics on database
    • Get database list
    • Get database information
    • Get database fields
    • Database wipe
  • Resources
  • Segments
  • Static segments
  • Suppression lists
  • Templates and fragments
  • 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).
  • Databases
  • Database wipe
Documentation for version v72

Database wipe

Description​

Wipes all data from a database:

  1. All customer or seed profiles.
  2. All associated data except statistics.

To use this request you need to reconfigure main.json file in config directory:

{
"ALLOW_DATA_WIPE": true
}

Request URL​

Method: POST

https://example.com/api/v1.1/databases/wipe

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
idint1Yesdatabase ID
formatint"json"NoResponse data format
By default – json

Request example​

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

Response example​

  • JSON
  • XML
{
"data": {
"count_action": 0,
"count_profile": 0
},
"error": 0,
"error_text": "Successful operation"
}
<?xml version="1.0" encoding="UTF-8" ?>
<xml>
<data>
<count_action>0</count_action>
<count_profile>0</count_profile>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>

Response parameters​

ParameterTypeDescription
dataJSON objectData object
data.count_actionintProfile actions wiped
data.count_profileintProfiles wiped
errorintError code
error_textstringError text
Last updated on Jan 14, 2026
Previous
Get database fields
Next
Resources
  • Description
  • Request URL
  • Request parameters
  • Request example
  • Response example
  • Response parameters
© 2015 - 2025 Altcraft, LLC. All rights reserved.