Skip to main content
POST
Create Sub-Account

Authorizations

X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Body

application/json
name
string

Name for the new sub-account.

Example:

"FoxHole"

Response

Sub-account successfully created.

id
integer

Unique ID for the sub-account.

Example:

50441

apiKey
string

API key for the sub-account.

Example:

"pR0YIuxYSbVwmQi2Y8Qs"

name
string

Name of the sub-account.

Example:

"API"

labels
string[]

Labels associated with the sub-account

Example:
smtpAuths
object[]

SMTP Auths associated with the sub-account

type
enum<integer>

Type of the sub-account

Available options:
0,
1
Example:

1

isPlus
boolean

Indicates whether the sub-account is a Plus sub-account

Example:

false

created
integer

UNIX epoch nano timestamp when the sub-account was created.

Example:

1733844681120384500

created_by
object | null

Member who created the sub-account

updated_by
object | null

Member who updated the sub-account

blocked
boolean

Indicates whether the sub-account is blocked

Example:

false

blocked_at
integer

UNIX epoch nano timestamp when the sub-account was blocked (0 if not blocked)

Example:

0

block_reason
string

Reason for blocking the sub-account

Example:

""

hb_exempt
boolean

Indicates whether the sub-account is exempt from hard bounce tracking

Example:

false

generate_weekly_report
boolean

Indicates whether weekly reports are generated for this sub-account

Example:

false

handlers
string[]

Handlers associated with the sub-account

Example: