---
title: "Update a tenant"
method: PUT
path: "/v1/domains/{domainId}/omnibus/{omnibusId}/tenants/{tenantId}"
tags: ["Tenants"]
---

# Update a tenant

`PUT /v1/domains/{domainId}/omnibus/{omnibusId}/tenants/{tenantId}`

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/omnibus/{omnibusId}/tenants/{tenantId}`
- Auth: none declared

## Path parameters

- `domainId` string, uuid, required
- `omnibusId` string, uuid, required
- `tenantId` string, uuid, required

## Request body

- OmnibusCreateOrUpdateTenantRequest
  - `alias` string, required: Alias for the tenant within the omnibus structure
  - `description` string: Optional description for the tenant (max 250 characters)
  - `status` 'LOCKED' | 'UNLOCKED'
  - `customProperties` OmnibusJsonNullableListTenantCustomProperty
    - `present` boolean

## Response `200`

OK

- OmnibusTenantResponse
  - `id` string, uuid, required: Unique identifier of the tenant
  - `omnibusId` string, uuid, required: Identifier of the omnibus structure this tenant belongs to
  - `alias` string, required: Alias of the tenant
  - `isHost` boolean, required: Whether this tenant is the host tenant of the omnibus structure. This field is immutable and set at creation time.
  - `status` 'LOCKED' | 'UNLOCKED', required
  - `createdAt` string, date-time, required: Timestamp when the tenant was created
  - `updatedAt` string, date-time, required: Timestamp when the tenant was last updated
  - `balances` OmnibusTenantBalanceEntry[]: Balances per ticker/ledger combination
    - `tickerId` string, uuid, required: Ticker identifier
    - `ledgerId` string, required: Ledger identifier
    - `reserved` string, required: Reserved amount
    - `quarantined` string, required: Quarantined amount
    - `availableBalance` string: Available balance from accounting service; absent if the accounting service is unavailable
  - `description` string: Description of the tenant
  - `customProperties` OmnibusTenantCustomProperty[]: Custom key-value properties
    - `key` string, required: Property key
    - `value` string, required: Property value

## Other responses

- `404`: Tenant not found

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)