Skip to main content
Sub-accounts are optional groups for end users, for example by customer segment, team, region, or product line. Use them when you need segmented user lists, reporting, or operational ownership. Skip them when all users can sit under one business account. Every business gets a default sub-account automatically. The default sub-account cannot be updated or deleted.

​
Create a sub-account

Create additional groups only when you need segmentation beyond the default.
POST /sub-accounts
Response

​
Assign a user on create

Pass subAccountId in POST /users to place a new user in that group.
User create field
If you omit subAccountId, the user is assigned to the business default sub-account.

​
Move an existing user

Use PATCH /users/{userId} to move a user to another active sub-account belonging to your business.
PATCH /users/USER_ID

​
List sub-accounts

GET /sub-accounts
Use q to search by name. Use fields to return selected fields such as id,name,isDefault.

​
Update a sub-account

Only the name can be changed. The default sub-account cannot be updated.
PATCH /sub-accounts/SUB_ACCOUNT_ID

​
Delete a sub-account

The default sub-account cannot be deleted. When you delete another sub-account, users are moved to the default sub-account unless you choose a different destination.
DELETE /sub-accounts/SUB_ACCOUNT_ID
Set deleteUsers: true to soft-delete all users in the group instead. Do not include subAccountId when deleteUsers is true.
Delete users in the group