---
title: "Update a Tenant"
method: PATCH
path: "/tenants/{id}"
tags: ["Admin"]
---

# Update a Tenant

`PATCH /tenants/{id}`

This endpoint updates the Tenant data.

## Path parameters

- `id` string, required

## Response `200`

Updated Tenant details

- Tenant
  - `id` string, required
  - `name` string, required — The tenant name. It should match the pattern `^[a-z-]+$`.
  - `base_url` string, required — The SDP backend server's base URL.
  - `sdp_ui_base_url` string, required — The SDP UI/dashboard Base URL.
  - `status` 'TENANT_CREATED' | 'TENANT_PROVISIONED' | 'TENANT_ACTIVATED' | 'TENANT_DEACTIVATED', required
  - `distribution_account_address` string, required — The Stellar account address used for distributing funds.
  - `distribution_account_type` 'DISTRIBUTION_ACCOUNT.STELLAR.ENV' | 'DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT' | 'DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT', required — The Stellar account type used for distributing funds.
  - `distribution_account_status` 'ACTIVE' | 'PENDING_USER_ACTIVATION', required — The status of the distribution account used for distributing funds.
  - `is_default` boolean, required — Boolean flag that shows whether the tenant is the default or not.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `deleted_at` string, date-time — The timestamp when the tenant was (soft) deleted.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/stellar/apis/stellar-disbursement-platform-api.md) · [All operations](https://skmtc.net/stellar/apis/stellar-disbursement-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stellar/stellar-disbursement-platform-api/revisions/39f9dc64156c/schema)
