Sign in

v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
SUBACCOUNTS

Add a subaccount

Adds a new subaccount on your master account.<strong> Note:</strong> This end-point is rate limited to 50 calls per hour.

post/subaccount/add

Request body

fullnamestring required

A full name used for the subaccount

subaccount_emailstring

An optional email address for the first team member in the subaccount. An email invitation will be sent to this address.

limitinteger

The number of emails the subaccount is allowed to send per billing cycle. <br><br><strong>Valid values:</strong><br>2000, 5000, 10000, 20000, 30000, 40000, 50000, 60000, 80000, 100000, 250000, 500000, 1000000, 2000000, 3000000, 5000000, 10000000

dedicated_ipboolean

Auto assign a dedicated IP to the subaccount (Only available if limit is greater than 100,000)

archivingboolean

Choose whether the subaccount is allowed to enable archiving. You still need to turn on archiving for individual senders within the subaccount.

enforce_2faboolean

Enforce team members of this subaccount to use 2FA.

enable_smsboolean

Enable SMS messaging for the subaccount. Additional charges apply.

sms_limitinteger

Your subaccount will be able to send up to this monthly limit of SMS messages. Their sending will also be limited by the master account's overall monthly limit.

Response

Subaccount added

request_idstring required

Example response

{
  "request_id": "0ef3f48a-2cfb-11eb-aee9-408d5cce2644",
  "data": {
    "name": "Test Person",
    "id": "NDU5OTgw",
    "plan_size": 10000,
    "plan_remaining": 10000,
    "state": "Active",
    "sms_limit": 1000
  }
}