Skip to navigation
API ReferenceSubaccounts

Update a Subaccount

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

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

Customer-facing resource name. 1–200 characters.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

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.

object"subaccount"
statusenum
Allowed values:
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