---
title: "PATCH /auth/tenants/{locator}/retire"
method: PATCH
path: "/auth/tenants/{locator}/retire"
---

# PATCH /auth/tenants/{locator}/retire

`PATCH /auth/tenants/{locator}/retire`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/auth/tenants/{locator}/retire`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/auth/tenants/:locator/retire/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `locator` string, uuid, required

## Response `200`

OK

- TenantResponse
  - `locator` string, uuid, required
  - `name` string, required
  - `type` 'test' | 'production' | 'retired' | 'deleted', required
  - `description` string
  - `createdAt` string, date-time, required
  - `createdBy` string, uuid, required
  - `updatedAt` string, date-time, required
  - `businessAccount` string, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)