PUT
/
subaccounts
/
{id}
Update Subaccount
curl --request PUT \
  --url https://api.cnaught.com/v1/subaccounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Operations Department",
  "email": "jane.doe@example.com",
  "default_portfolio_id": "eWvNvC12"
}'
{
  "id": "5nubL0NS",
  "name": "Operations Department",
  "email": "jane.doe@example.com",
  "default_portfolio_id": "eWvNvC12",
  "logo_url": "https://customer-assets.cnaught.com/fe0df075-30e2-4e58-9feb-154e72a9205f/subaccount_logo.png"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

ID of subaccount to return / modify

Examples:

"5nubL0NS"

Body

application/json

Subaccount Update Parameters

​
name
string
required

Name for the subaccount

Maximum length: 512
​
email
string | null

Optional email associated with the subaccount. If not specified, will remove the email from the subaccount.

Examples:

"jane.doe@example.com"

​
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.

Examples:

"a23bF6"

Response

Subaccount Details after update

​
id
string

Identifier that can be used to retrieve the subaccount details

Examples:

"5nubL0NS"

​
created_on
string

Timestamp of when the subaccount was created (in UTC)

​
name
string

Name of the subaccount

Maximum length: 512
​
email
string | null

Optional email associated with the subaccount.

Examples:

"jane.doe@example.com"

​
default_portfolio_id
string | null

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

Examples:

"a23bF6"

​
logo_url
string | null

Optional URL for the logo used for this subaccount, if any. This URL is for the logo as stored on CNaught's hosting.