Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ivory.finance/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

PATCH /v1/admin/tenants/{slug} performs a partial update on mutable tenant fields. Only the fields included in the request body are changed. Automatically invalidates the TenantMiddleware Valkey cache so changes take effect on the next request.
This endpoint is restricted to the admin Kong consumer via ACL.

​
Path parameters

​
slug
string
required
The tenant slug (e.g. acme-bank).

​
Request

All fields are optional — include only the ones you want to change.
​
display_name
string
New human-readable tenant name.
​
tier
string
New billing tier. One of: pilot · enterprise · enterprise_plus
​
custom_domain
string
Custom domain for this tenant’s console (e.g. portal.acmebank.com).

​
Response

Returns the full updated tenant record. See GET /v1/admin/tenants/{slug} for field descriptions.

​
Examples

curl -X PATCH https://api.ivory.finance/v1/admin/tenants/acme-bank \
  -H "X-API-Key: YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Acme Bank & Trust",
    "tier": "enterprise_plus"
  }'

​
Error responses

CodeReason
404No tenant found with that slug
422Invalid tier value