Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v72
  • v74
  • v73
  • v72
Login
  • Getting Started
  • Administrator documentation
  • Functional characteristics
  • Technology description
  • System requirements
  • Admin Panel
  • Platform installation
  • Platform configuration
  • Platform maintenance
  • Custom channels guide
  • Extra
  • Processing HTTP/HTTPS traffic
  • Administrator API
    • Accountsv72
      • Restricted access
      • Get accounts list
      • Add a new account
      • Delete the account
    • Account users
    • Nodes
    • Sendersv72
    • Virtual senders
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).
  • Administrator API
  • Accountsv72
  • Add a new account
Documentation for version v72

Add a new account

Description​

Create a new platform account

Request URL​

Method: POST

https://example.com/api/v1.1/admin/accounts/save

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
(By default – json)
idint1NoAccount ID
namestring"Account name"YesAccount name
titlestring"example title"YesAccount title
tzstring"UTC"YesAccount time zone
tariffint/string"example tariff"YesTariff ID or name
web_version_policyint/string"0"NoWeb version policy ID or name
account_postgresqlint/string"2"NoPostgresql account ID or name
account_cache_clickhouseint/string"3"NoClickhouse account ID or name
external_data_connectorsint[1,2,3,4]NoExternal data connectors
reports_dayint4YesDay of the report
reports_hourint18YesTime of the report
force_2fa_authboolfalseNoRequirement of mandatory use of two-factor authentication
enable_pushbooltrueNoEnabling Push Notifications
custom_push_domainstring"example.com"NoDomain of custom push notifications
enable_smart_settingsbooltrueNoAccess to smart settings
enable_pixelbooltrueNoEnabling a pixel
enable_track_email_repliesboolfalseNoTracking email replies

Request example​

  • JSON
  • XML
{
"token": "aabcdefghijklmnqrstuvwxyz",
"name": "Steve",
"title": "ASdf",
"tz": "UTC",
"tariff": "example tariff",
"reports_day": 5,
"reports_hour": 22
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<name>Steve</name>
<title>ASdf</title>
<tz>UTC</tz>
<tariff>example tariff</tariff>
<reports_day>5</reports_day>
<reports_hour>22</reports_hour>
</xml>

Response example​

  • JSON
  • XML
{
"data": {
"saved_id": 6
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data>
<saved_id>6</saved_id>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>

Response parameters​

ParameterTypeDescription
errorintError code
error_textstringError text
saved_idintAccount ID
Last updated on Oct 24, 2024
Previous
Get accounts list
Next
Delete the account
  • Description
  • Request URL
  • Request parameters
  • Request example
  • Response example
  • Response parameters
© 2015 - 2025 Altcraft, LLC. All rights reserved.