For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
      • GETGet the list of all the sub-accounts of the master account.
      • POSTCreate a new sub-account under a master account.
      • GETGet sub-account details
      • DELDelete a sub-account
      • PUTUpdate sub-account plan
      • PUTUpdate sub-accounts plan
      • POSTGenerate SSO token to access admin account
      • POSTGenerate SSO token to access sub-account
      • GETGet the details of requested master account
      • POSTCreate an API key for a sub-account
      • PUTEnable/disable sub-account application(s)
      • POSTCreate a new group of sub-accounts
      • GETList of all IPs
      • POSTAssociate an IP to sub-accounts
      • PUTDissociate an IP to sub-accounts
      • GETGET a group details
      • PUTUpdate a group of sub-accounts
      • DELDelete a group
      • PUTDelete sub-account from group
      • POSTSend invitation to an admin user
      • PUTResend / cancel admin user invitation
      • DELRevoke an admin user
      • GETGet the list of all admin users
      • GETCheck admin user permissions
      • PUTChange admin user permissions
      • GETGet the list of groups
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Accounts and SettingsMaster Account

Create a new sub-account under a master account.

POST
https://api.brevo.com/v3/corporate/subAccount
POST
/v3/corporate/subAccount
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.masterAccount.createANewSubAccountUnderAMasterAccount({
8        companyName: "Test Sub-account",
9        email: "test-sub@example.com",
10        groupIds: [
11            "5f8f8c3b5f56a02d4433b3a7",
12            "5f8f8c3b5f56a02d4433b3a8",
13        ],
14        language: "fr",
15        timezone: "Europe/Paris",
16    });
17}
18main();
1{
2  "id": 4109344
3}

This endpoint will create a new sub-account under a master account

Was this page helpful?
Previous

Get sub-account details

Next
Built with

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Request body with sub-account organization name

companyNamestringRequired

Set the name of the sub-account company

emailstringRequired
Email address for the organization
groupIdslist of stringsOptional

Set the group(s) for the sub-account

languageenumOptional

Set the language of the sub-account

timezonestringOptional

Set the timezone of the sub-account

Response

Created sub-account ID

idlong

ID of the sub-account created

Errors

400
Bad Request Error