Middesk APISub Accounts

Create a sub-account

Creates a sub-account and provisions an initial sandbox API key. external_id is an idempotency key unique within the parent account: repeating a request with the same external_id returns the existing sub-account with 200 and no api_keys field. With inherit_products_from_parent enabled (the default), parent product changes cascade to the sub-account. When disabled, products is required and the sub-account is independent.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired

Display name for the sub-account

external_idstringRequired>=1 character

Idempotency key unique within the parent account. Reusing it returns the existing sub-account instead of creating another one.

productslist of enumsOptional

Products enabled for the sub-account. Every value must be enabled on the parent account. Required when inherit_products_from_parent is false.

inherit_products_from_parentbooleanOptionalDefaults to true

When true, product changes on the parent cascade to this sub-account. When false, the sub-account’s products are independent and products is required.

websitestringOptional
Required for accounts with a Middesk partner profile
verticalenumOptional
Required for accounts with a Middesk partner profile
sub_verticalenumOptional
Required for accounts with a Middesk partner profile. The value must belong to the selected vertical.
use_caseenumOptional
Required for accounts with a Middesk partner profile
contactobjectOptional
Required for accounts with a Middesk partner profile
deal_namestringOptional
estimated_volumeintegerOptional>=1
go_live_datedateOptional

Future date in YYYY-MM-DD format

Response

existing sub-account returned for the external ID

objectenum
idstringformat: "uuid"
namestring
external_idstring or null
Idempotency key supplied by the parent account, unique within that parent
enabledboolean
productslist of strings
created_atdatetime

Errors

400
Create Sub Account Request Bad Request Error
403
Create Sub Account Request Forbidden Error