Manage sub-accounts under a partner or organization account. Sub-accounts are independent accounts with their own users, contacts, and campaigns, managed by the parent account. Includes creation, suspension, and configuration.
Show all sub-accounts
List all sub-accounts under the authenticated partner or organization account.
Required scope(s): sub_accounts:read
query Parameters
partner_account_idrecursivepageper_pagewith_countInclude count in the response
Include count in the response
sortSort term and direction, using syntax [-|+]term.
Valid terms:
namecreated_on
Sort term and direction, using syntax [-|+]term.
Valid terms:
namecreated_on
filterValid Terms:
namestatus
Valid Operators:
==
Query separator:
;
Valid Terms:
namestatus
Valid Operators:
==
Query separator:
;
Show all sub-accounts › Responses
Successful Response
Create a sub-account
Create a new sub-account under the authenticated partner or organization account.
Required scope(s): sub_accounts:write
query Parameters
partner_account_idskip_verificationCreate a sub-account › Request Body
nameAccount display name
faxphonewebsiteAccount website URL
trialWhether this is a trial account
partnerWhether this is a partner account
Create a sub-account › Responses
Successful Response
idobjectemailmetadatacreatedDelete a sub-account
Delete a sub-account. This action is permanent.
Required scope(s): sub_accounts:admin
path Parameters
account_id^[a-zA-Z0-9]+$ · requiredDelete a sub-account › Responses
Successful Response
idobjectdeletedUpdate a sub-account
Update a sub-account's settings, including name, address, usage limits, and feature flags.
Required scope(s): sub_accounts:write
path Parameters
account_idUpdate a sub-account › Request Body
nameAccount display name
faxphonewebsiteAccount website URL
trialWhether this is a trial account
partnerWhether this is a partner account
metadataArbitrary metadata for the account
Update a sub-account › Responses
Successful Response
Suspend a sub-account
Suspend a sub-account, preventing its users from logging in or sending emails.
Required scope(s): sub_accounts:admin
path Parameters
account_idSuspend a sub-account › Responses
Successful Response
idobjectsuspendedUnsuspend a sub-account
Restore a suspended sub-account, allowing its users to log in and send emails again.
Required scope(s): sub_accounts:admin
path Parameters
account_idUnsuspend a sub-account › Responses
Successful Response
idobjectunsuspendedConfirm sub-account creation
Confirm a pending sub-account using the confirmation token from the verification email.
path Parameters
account_id^[a-zA-Z0-9]+$ · requiredConfirm sub-account creation › Responses
Successful Response
idobjectemailmetadataconfirmedResend the account verification email
Resend the verification email for a pending sub-account.
Resend the account verification email › Request Body
emailEmail address to resend the verification to
Resend the account verification email › Responses
Successful Response
objectverification_resentConvert an account to an Organization
Convert a sub-account into an organization, allowing it to manage its own sub-accounts.
Required scope(s): sub_accounts:admin
path Parameters
account_idConvert an account to an Organization › Request Body
migrate_ownerMigrate the account owner from the original account to the Organization.
Convert an account to an Organization › Responses
Successful Response