Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guide iconUser guide
Developer guide iconDeveloper guide
Admin guide iconAdmin guide
English
  • Русский
  • English
Login
    Getting StartedAdministrator documentationFunctional characteristics
      Technology descriptionarrow
    • Architecture OverviewComponent Description
        Deployment schemesarrow
      • Basic schemeFail-safe schemeTypical Placement in Infrastructure
    System requirements
      Admin Panelarrow
      • Account areaarrow
        • Accountsarrow
        • Account UsersAccount Virtual SendersAccount Database Indexes
        TariffsExternal data configurationLDAPTasksSchedule JobsGlobal Stop ListsWebversion Store Policies
        Settingsarrow
      • Databases
          Accessarrow
        • AdminsAPI tokens
        Notifiers
          MTAarrow
        • Default rulesRetry rulesLock rulesBounce patternsStrategiesKeysISPsPools
      Nodes
        Sendersarrow
      • EmailSMSEvent generatorIntegration with SendsayENS: настройка сендера
        Reportsarrow
      • Audit JournalData Usage
        Toolsarrow
      • ARF decoderURL decoderSMID decoderLicense
      Platform installationarrow
    • Automatic installationManual installationRunning the platform in a Docker container
      Platform configurationarrow
    • Configuration fileDomain settingsLDAP access configurationSending Email via SMTP relayPixel and push domain configurationCluster and Replication SetupSystem notifications configurationProcesses UNIX sockets configurationHTTPS ConfigurationMigrating from MongoDB Community Edition to Percona Server for MongoDBAdding sender IP addressesDeduplication request settingsPostgreSQL database for account dataProxy server settingsKeycloak Integration with AltcraftGetting HTTP service statusesConfiguration MongoDB logs rotation
        Configuration of system constants and directoriesarrow
      • Filtering bot actionsDirectory of gender markers
      Platform maintenancearrow
    • Personnel requirementsPlatform maintenance processesPlatform updatingPlatform service monitoringBackup and recoveryTransferring the platform to a new serverCreating, deleting, and populating tables for statistics in ClickHouseUsage of the aktool utilityUsers and directories engaged by the platform
      Custom channels guidearrow
    • OverviewCreating and configuring a channelEntity field configurationTemplate languageEntities
        Pipesarrow
      • Pipe: Basic ConceptsResultErrorsLogPackUnpackHTTP RequestStore SetStore GetSelectorSQLEventerScheduler
        Pipelinesarrow
      • Pipeline: Basic ConceptsMessageScheduleListenerModerateStop
      Extraarrow
    • System page customizationSend Message IDИнструкция по миграции истории в ClickHouseInstructions for migrating history to ClickHouseUtility for importing push subscriptions to Firebase projectUtility for importing push subscriptions to Firebase project
    Processing HTTP/HTTPS traffic
      Administrator APIarrow
      • Accounts admin apiarrow
        • Restricted accessarrow
        • Account Activation and DeactivationAccount Freeze and Unfreeze
        Get accounts listAdd a new accountDelete the account
        Account usersarrow
      • Update an Existing AccountAdd a new accountDelete a userGet a list of usersSending a Welcome Email
        Nodesarrow
      • Synchronize node MTA configurationGet nodes listGet node MTA statusActivate node MTADeactivate node MTA
        Senders admin apiarrow
      • Create or update AKMTA senderGet AKMTA sender informationAssign account to senderGet senders listDelete senderRestore sender
          Sender queuearrow
        • Get sender queue informationHold sender queueRelease sender queueClear sender queue
        Virtual sendersarrow
      • Get virtual senders listGet virtual sender informationCreate virtual senderUpdate virtual senderClone virtual senderDelete virtual sender
    Documentation Archive
  • Administrator API
  • Accounts admin api
  • Add a new account

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 - 2026 Altcraft, LLC. All rights reserved.