Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0652106151.4 KB
subaccounts

Create Subaccount.

Create subaccount.

post/subaccounts

Request body

emailstring email required
ipstring required

IP address to use for sending emails.

first_namestring required

subaccount owner first name

last_namestring required

subaccount owner last name

address_1string nullable

Address Line 1

address_2string nullable

Address Line 2

citystring nullable

City

company_namestring nullable

Agency Name

countrystring nullable

Country

regionstring nullable

Region

zip_codestring nullable

Zip Code

phone_numberstring nullable

Phone Number

policy_agreeboolean required

Policy must be agreed in order to be able to create a subaccount.

site_urlstring nullable

Website

passwordstring required

subaccount password

confirm_passwordstring required

subaccount confirm password

Example request

{
  "email": "username@gmail.com",
  "ip": "185.228.36.19",
  "first_name": "Andrea",
  "last_name": "Willems",
  "address_1": "51 Guild Street",
  "address_2": "1st Floor",
  "city": "London",
  "company_name": "Refreshing Soda Inc.",
  "country": "United Kingdom",
  "region": "West",
  "zip_code": "NW10 9NQ",
  "phone_number": "5493513164544",
  "policy_agree": true,
  "site_url": "https://www.refreshing-soda.com",
  "password": "LetmeIn123!",
  "confirm_password": "LetmeIn123!"
}

Response

Sub account details.

emailstring email required
ipstring

IP address to use for sending emails.

activeboolean required

Active subaccounts can be used for login purpose, while users can´t login to inactive subaccounts. Notice that in order to be able to send emails the subaccount subscription must also be active. User can set subaccounts to active / inactive from the dashboard.

subaccount_idinteger

Sub account Id

parent_idinteger

Sub account parent Id

first_namestring

subaccount owner first name

last_namestring

subaccount owner last name

address_1string nullable

Address Line 1

address_2string nullable

Address Line 2

citystring nullable

City

company_namestring nullable

Agency Name

countrystring nullable

Country

regionstring nullable

Region

zip_codestring nullable

Zip Code

phone_numberstring nullable

Phone Number

policy_agreeboolean

Policy must be agreed in order to be able to create a subaccount.

site_urlstring nullable

Website

Example response

{
  "active": true,
  "email": "client@clientdomain.com",
  "subaccount_id": 19302132,
  "parent_id": 22190623,
  "ip": "185.228.36.19",
  "first_name": "Andrea",
  "last_name": "Willems",
  "address_1": "",
  "address_2": "",
  "city": "",
  "company_name": "Refreshing Soda Inc.",
  "country": "",
  "region": "",
  "zip_code": "",
  "phone_number": "",
  "policy_agree": true,
  "site_url": ""
}