SubAccounts

Get SubAccount

get

Retrieve information about a specific sub-account. Only available for agency and developer accounts.

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
emailstring ยท emailRequired

Email of the sub-account to retrieve

Responses
chevron-right
200

Sub-account found

application/json
get
/subaccounts

Create SubAccount

post

Create a new sub-account within your agency. Only available for agency and developer accounts.

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
emailstring ยท emailRequired

Sub-account user's email address

first_namestringRequired

Sub-account user's first name

last_namestringRequired

Sub-account user's last name

business_namestringOptional

Business name for the sub-account

descriptionstringOptional

Business description

address_linestringOptional

Business address line

citystringOptional

Business city

countrystringOptional

Business country

postal_codestringOptional

Business postal code

statestringOptional

Business state

time_zone_idstringOptional

Time zone identifier

languagestringOptional

Preferred language

Responses
post
/subaccounts

Delete SubAccount

delete

Delete a specific sub-account. Only available for agency and developer accounts.

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
emailstring ยท emailRequired

Email of the sub-account to delete

Responses
chevron-right
200

Sub-account deleted successfully

application/json
delete
/subaccounts

Last updated

Was this helpful?