Create Subaccount

Creates a new Subaccount.

POST/subaccounts

Authorizations#

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your CNaught API key.

Headers#

Idempotency-Key

string

If present, a unique identifier that allows you to retry a request multiple times while only performing the action once. See Idempotency for more info.

Body#

Subaccount Parameters

name

string

required

Name for the subaccount

string | null

Optional email associated with the subaccount

default_portfolio_id

string | null

Optional ID of the default portfolio to use for fulfilling orders placed for this subaccount. If not specified, the parent account's default portfolio will be the default portfolio for the subaccount.

logo_url

string | null

Optional URL for a logo to use for this subaccount. The URL must be public. The logo will be downloaded to CNaught's hosting when creating the account. If not specified, the subaccount will not have a logo.

Response#

201

Subaccount Details

Show response attributes

Get List of Subaccounts

Get Subaccount By Id

Create Subaccount

curl --request POST \
  --url https://api.cnaught.com/v1/subaccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Marketing Department",
  "email": "jane.doe@example.com",
  "default_portfolio_id": "mHvNvWbq"
}'

{
  "id": "5nubL0NS",
  "name": "Marketing Department",
  "email": "jane.doe@example.com",
  "default_portfolio_id": "mHvNvWbq",
  "logo_url": "https://customer-assets.cnaught.com/VChGzdcf/4b1cdc0f-fb47-4251-ab52-b0566369723b/logo"
}