subaccounts

Update Subaccount

Update an existing subaccount. Requires user:manage on the subaccount.

patch/v1/subaccounts/{subaccount_id}

Path parameters

subaccount_idstring required

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

subaccount_idstring uuid required
org_idstring uuid required
namestring required
descriptionstring nullable
account_type'custodial' | 'non_custodial' required

Type of trading subaccount.

is_activeboolean required
inserted_atstring required
permissionsstring[] required
rolestring required

Changes

Changed in 1 of the 9 revisions of this API.3

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added