Create a new sub-account

post

https://api.convert.com/api/v2/accounts/{account_id}/sub-accounts/add

Creates a new sub-account under the specified parent main account. Sub-accounts inherit certain properties and limits from the parent but can have their own users and projects. This is typically used by agencies or larger organizations to manage client accounts or departmental usage separately.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the parent account under which the sub-account is being created.

Body Params

A JSON object with details for the new sub-account, including its name, the initial owner's name and email, and specific billing plan configurations and usage limits.

Account details data

accountType

string

enum

Defines the type of the account:

main: A primary account that can have sub-accounts and manages its own billing.
sub: A secondary account existing under a main account, often used by agencies to manage client activities. Sub-accounts share quotas from the parent.

Allowed:

name

string

required

length ≤ 200

The user-defined, friendly name for the account (e.g., "Client X Marketing", "My Company Inc.").

accessRole

string

enum

The predefined names for user access roles within the Convert system. Each role grants a specific set of permissions.

owner: Highest level, full control over account, billing, users, and all projects. Typically the account creator.
account_manager: Broad administrative rights over the account, often including billing and user management, but might not be able to delete the account itself.
admin: Full control over projects they are assigned to, including creating/editing/deleting experiences, goals, audiences, and managing project settings. May also manage project-level collaborators.
browse: Read-only access. Can view experiences, reports, and settings but cannot make changes.
edit: Can create and modify entities like experiences, goals, audiences within assigned projects, but typically cannot activate/publish experiences or manage project settings.
publish: Can do everything an 'editor' can, plus activate/pause/complete experiences.
review: Can view and comment, but not make direct changes. Suited for stakeholders who need to approve or provide feedback. Knowledge Base: "Collaborators - Share With Multiple Users / Accounts" (describes access levels).

Allowed:

settings

object

Various Account level settings that can be controlled by the user

billing

object

required

userName

string

required

Name of the user that would own this account.

userEmail

string

required

Email of the user that would own this account. If the an user exists with that email, the respective user would be used. Otherwise, a new user would get created.

sendUserEmail

boolean

Defaults to false

Flag indicating whether an email to be sent or not to the user, notifying them that an account was created for them by main account.

An email with a complete sign-up link would be sent regardless if the user does not exist into the system and gets created.

customEmailText

string

length ≤ 1024

Custom text to be appended to the email that gets sent to the user if sendUserEmail = true

Response

200Detailed information for a specific account, including its name, type (main/sub), billing information, usage limits, subscribed products (Experiences, Deploy), and general settings.