Update a subaccount

View as Markdown
Update one subaccount name, external identifier, metadata, or configured limits.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired1-64 characters
Opaque identifier for a BCTRL subaccount.

Request

This endpoint expects an object.
externalIdstring or nullOptional1-200 characters
limitsobjectOptional
metadataobject or nullOptional
namestringOptional1-200 characters

Response

OK
createdAtstring
defaultSpaceIdstringformat: "uuid"
idstring1-64 characters
Opaque identifier for a BCTRL subaccount.
limitsobject
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

statusenum
updatedAtstring
archivedAtstring or nullOptional
externalIdstring or nullOptional
metadataobject or nullOptional
usageobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error