Update Subaccount | BCTRL Docs

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

{
  "createdAt": "2024-04-01T12:00:00Z",
  "defaultSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "subacct-67890",
  "limits": {
    "maxActiveRuns": 10,
    "maxSpaces": 5,
    "monthlyCreditLimit": 500
  },
  "name": "Marketing Team Subaccount",
  "status": "active",
  "updatedAt": "2024-04-15T08:30:00Z",
  "archivedAt": "null",
  "externalId": "ext-12345",
  "metadata": {},
  "usage": {
    "blockedReasons": [
      "monthlySpendLimit"
    ],
    "computedAt": "2024-04-15T09:30:00Z",
    "credits": {
      "breakdown": {
        "aiCredits": 120.5,
        "browserCredits": 30,
        "captchaCredits": 15,
        "filesCredits": 10,
        "proxyCredits": 25.5
      },
      "estimated": 201,
      "limit": 500,
      "remaining": 299,
      "settled": 150,
      "used": 201
    },
    "isBlocked": true,
    "period": {
      "endsAt": "2024-04-30T23:59:59Z",
      "startedAt": "2024-04-01T00:00:00Z"
    },
    "runs": {
      "active": 3,
      "blocked": true,
      "limit": 10
    },
    "spaces": {
      "blocked": true,
      "limit": 5,
      "used": 5
    },
    "subaccountId": "subacct-67890"
  }
}

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired

Request

This endpoint expects an object.

externalIdstring or nullOptional1-200 characters

limitsobjectOptional

metadataobject or nullOptional

namestringOptional1-200 characters

Response

createdAtstring

defaultSpaceIdstringformat: "uuid"

idstring>=1 character

limitsobject

namestring>=1 character

statusenum

updatedAtstring

archivedAtstring or null

externalIdstring or null>=1 character

metadataobject or null

usageobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error