Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Subaccount API

Create Subaccount

Create a new Email API subaccount under your master account.

post/subaccounts/createSubaccount

Headers

api_keystring required
Example:x-api-key-123456789

Add your master account API key to authorize this request.

Request body

usernamestring required

Add a unique username for the subaccount. Use this value in all future subaccount API calls.

emailstring required

Add the subaccount owner email address where the activation link will be sent.

setpasswordinteger required

Set whether you want to define the password now — use 1 to set password here or 0 to let the user set it via email link.

passwordstring

Add a password for the subaccount when setpassword = 1. Must meet password policy requirements.

credit_typestring

Choose credit mode for this subaccount — unlimited or one_time_credit.

Example request

{
  "username": "acme_marketing_team",
  "email": "owner@acme.com",
  "setpassword": 1,
  "password": "Acme@1234",
  "credit_type": "one_time_credit"
}

Response

Subaccount created successfully