v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB

SubAccounts

Add SubAccount

Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter. Required Access Level: ModifySubAccounts

post/subaccounts

Request body

Emailstring string required

Proper email address.

Passwordstring string required

Current password.

SendActivationboolean

True, if you want to send activation email to this Account to confirm the creation of a new SubAccount. Otherwise, false (SubAccount will immediately be Active).

Example request

{
  "Email": "mail@example.com",
  "Password": "********",
  "Settings": {
    "Email": {
      "PoolName": "My Custom Pool"
    }
  }
}

Response

Created

PublicAccountIDstring string

Public key for limited access to your Account such as contact/add so you can use it safely on public websites.

Emailstring string

Proper email address.

LastActivitystring date-time

Date of last activity on Account

EmailCreditsinteger

Amount of email credits

TotalEmailsSentinteger

Amount of emails sent from this Account

Reputationnumber double

Numeric reputation

Status'Disabled' | 'UnderReview' | 'NeverSignedIn' | 'Active'

ContactsCountinteger

How many contacts this SubAccount has stored

Example response

{
  "PublicAccountID": "EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F",
  "Email": "mail@example.com",
  "Settings": {
    "Email": {
      "PoolName": "My Custom Pool"
    }
  },
  "LastActivity": "2001-01-01T12:00:00"
}