Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

User Subaccounts

Request a new REST API token for sub-account

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Sub-Accounts/requestNewSubaccountToken" target="_blank">Try in sandbox</a><br>Returning user object, key and app name.

post/api/v2/subaccounts/tokens

Request body

userIdinteger required

Sub-account ID.

passwordstring required

Your account password.

appNamestring

Application name.

Example request

{
  "userId": 1,
  "password": "strongPassword",
  "appName": "sample app"
}

Response

Created Sub-account data returned with success.

idinteger required

User ID.

displayTimeFormat'12h' | '24h'

User's preferred format of time display:

  • 12h - AM/PM format;
  • 24h - 24-hour clock format.
usernamestring required

Username.

firstNamestring required

Account first name.

lastNamestring required

Account last name.

emailstring required

User email address.

status'A' | 'T' required

Current account status:

  • A for Active;
  • T for Trial.
balancenumber required

Account balance (in account currency).

phonestring nullable required

User's phone number.

companystring nullable required

Account company name.

subaccountType'P' | 'A' | 'U' required

Type of account:

  • P for Parent User;
  • A for Administrator Sub-Account;
  • U for Regular User.
emailAcceptedboolean required

Does the account have a confirmed email?

phoneAcceptedboolean required

Does the account have a confirmed phone number?

Example response

{
  "id": 305,
  "displayTimeFormat": "24h",
  "username": "charles.conway",
  "firstName": "Charles",
  "lastName": "Conway",
  "email": "charles@example.com",
  "status": "A",
  "balance": 208.64,
  "phone": "447860021130",
  "company": "Example Ltd.",
  "currency": {
    "id": "GBP",
    "unicodeSymbol": "£",
    "htmlSymbol": "&pound;"
  },
  "country": {
    "id": "US",
    "name": "India"
  },
  "timezone": {
    "id": 55,
    "area": "Europe",
    "dst": 1,
    "offset": 10800,
    "timezone": "Europe\\/Tallinn"
  },
  "subaccountType": "P",
  "emailAccepted": true,
  "phoneAccepted": true,
  "avatar": {
    "href": "avatars/lav5d8de21d89971646555094.png"
  }
}