Creates an account in our platform and returns an Account object with account id

Request Information

Headers

NameDescriptionTypeAdditional information
Authentication

Authentication token

string

Required

URI Parameters

None.

Body Parameters

Account model

Account
NameDescriptionTypeAdditional information
ExternalId

Id for this account in your system (if you keep a list of accounts in your own system)

string

Max length: 250

FirstName

First name

string

None.

LastName

Last name

string

None.

Email

Email

string

None.

Password

Password

string

None.

Type

Account type

string (Enumeration value of AccountType )

Possible values: Basic, Premium

Required

AccountPlanId

Account plan id

integer

Required

ParentAccountId

Account id of the parent account (for Reseller API key and for Basic accounts (sub-accounts) only )

globally unique identifier

Required if API key is for Reseller and account type is 'Basic' (it's a sub-account) and you have the ability to create Premium (multi-user) accounts

PremiumAccountInfo

Additional Premium account info (for Premium accounts only)

PremiumAccountInfo

Required if account type is 'Premium'

Request Formats

application/json

Samples:
Premium account:
{
  "ExternalId": "externalid",
  "Type": "Premium",
  "AccountPlanId": 2,
  "FirstName": "First name",
  "LastName": "Last name",
  "Email": "someemail@gmail.com",
  "Password": "somepassword",
  "PremiumAccountInfo": {
    "CompanyShortName": "Company name",
    "CompanyFullName": "Full company name",
    "MobileDomain": "somemobidomain.mobi",
    "ControlPanelDomains": "somecp.domain.com"
  }
}
Basic account:
{
  "ExternalId": "externalid",
  "Type": "Basic",
  "AccountPlanId": 1,
  "ParentAccountId": "fa516117-9d6a-4eb0-b5c1-0ca80db618c4",
  "FirstName": "First name",
  "LastName": "Last name",
  "Email": "someemail@gmail.com",
  "Password": "somepassword"
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
Data

Account

None.

Success

boolean

None.

Messages

Collection of ErrorMessage

None.

Response Formats

application/json

Samples:
Premium account:
{
  "Data": {
    "Id": "fa516117-9d6a-4eb0-b5c1-0ca80db618c4",
    "ExternalId": "externalid",
    "Type": "Premium",
    "AccountPlanId": 2,
    "Status": "Active",
    "FirstName": "First name",
    "LastName": "Last name",
    "Email": "someemail@gmail.com",
    "PremiumAccountInfo": {
      "CompanyShortName": "Company name",
      "CompanyFullName": "Full company name",
      "MobileDomain": "somemobidomain.mobi",
      "ControlPanelDomains": "somecp.domain.com"
    }
  },
  "Success": true,
  "Messages": []
}
Basic account:
{
  "Data": {
    "Id": "073f4072-9870-438d-818b-c7e56eff2601",
    "ExternalId": "externalid",
    "Type": "Basic",
    "AccountPlanId": 1,
    "Status": "Active",
    "ParentAccountId": "0f0f72c9-c216-41aa-841e-e096fc741f6f",
    "FirstName": "First name",
    "LastName": "Last name",
    "Email": "someemail@gmail.com"
  },
  "Success": true,
  "Messages": []
}