Update Subaccount | BCTRL Docs

Update a subaccount name, external identifier, metadata, or limits. Use this to keep tenant administration and account controls aligned with your own system.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

externalIdstring or nullOptional1-200 characters

limitsobjectOptional

metadatamap from strings to any or nullOptional

namestringOptional1-200 characters

Response

Default Response

createdAtstring

idstring>=1 character

limitsobject

namestring>=1 character

slugstring>=1 character

statusenum

Allowed values:

updatedAtstring

archivedAtstring or null

externalIdstring or null>=1 character

metadatamap from strings to any or null

1	curl -X PATCH https://api.bctrl.ai/v1/subaccounts/id \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"createdAt": "2023-11-15T09:30:00Z",
3	"id": "subacc-1234567890",
4	"limits": {
5	"maxActiveRuns": 10,
6	"maxSpaces": 5,
7	"monthlyCreditLimitMicroUsd": 5000000
8	},
9	"name": "Acme Corp Subaccount",
10	"slug": "acme-corp-subaccount",
11	"status": "active",
12	"updatedAt": "2024-06-01T12:00:00Z",
13	"archivedAt": "null",
14	"externalId": "tenant-7890",
15	"metadata": {}
16	}