Skip to main content
POST
/
sub-account
Create Sub-account
curl --request POST \
  --url https://api.mailchannels.net/tx/v1/sub-account \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "company_name": "<string>",
  "handle": "<string>"
}
'
{
  "enabled": true,
  "handle": "<string>",
  "company_name": "<string>"
}

Headers

​
X-Api-Key
string
required

Body

application/json

The details of the sub-account to create.

​
company_name
string
required

The name of the company associated with the sub-account. This name is used for display purposes only and does not affect the functionality of the sub-account. The length must be between 3 and 128 characters.

​
handle
string

A unique name for the sub-account to be created. The length must be between 3 and 128 characters, and it may contain only lowercase letters and numbers. If not provided, a random handle will be generated.

Response

The sub-account was successfully created.

​
enabled
boolean
required
​
handle
string
required
​
company_name
string