Sub-Accounts

Update sub-account

Changed on

Update sub-account. Requires a parent project API key; sub-account API keys receive HTTP 403.

patch/v1/sub-accounts/{id}

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/sub-accounts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Sub-account ID.

Request body

namestring
externalIdstring
creditLimitinteger nullable
metadataobject
status'active' | 'inactive' | 'pending_deletion'

active and inactive are set with PATCH. pending_deletion is read-only: the sub-account was deactivated with DELETE, its API keys are revoked, and it is removed after 14 days.

Response

Sub-account updated.

Example response

{
  "subAccount": {
    "name": "Client ABC"
  }
}

Changes