---
title: "Modify an existing Tenant."
method: PUT
path: "/tenants/{id}"
tags: ["Tenants"]
---

# Modify an existing Tenant.

`PUT /tenants/{id}`

## Path parameters

- `id` string, required

## Request body

- ModifyTenantCommand
  - `Description` string
  - `Id` string, required — ID of the Tenant to modify.
  - `IsDisabled` boolean
  - `Name` string, required
  - `ProjectEnvironments` object — The complete set of projects the tenant is connected to, as an object keyed by project ID where each value is the array of environment IDs the tenant can deploy to for that project. Example: {"Projects-1": ["Environments-1"]}. Replaces the tenant's current connections; omitting an existing project disconnects it and deletes the tenant's variable values for it.
  - `Slug` string — A URL-friendly, unique identifier for the tenant. Resubmit the tenant's current slug unless you intend to change it; changing it breaks existing links that use the old slug.
  - `SpaceId` string, required
  - `TenantTags` string[] — The complete set of tags for the tenant, as canonical tag names in the form 'TagSetName/TagName'. Example: ["Regions/EU-West", "Tier/Premium"]. Replaces the tenant's current tags; any existing tag omitted here is removed.

## Response `200`

Confirms that a Tenant has been modified, containing the updated Tenant

- TenantResource
  - `ClonedFromTenantId` string
  - `CustomFields` string[]
  - `Description` string
  - `Icon` IconResource
    - `Color` string — Icon background colour, as a Hex string
    - `Id` string — Font Awesome Icon Id
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IsDisabled` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `Name` string
  - `ProjectEnvironments` object
  - `Slug` string
  - `SpaceId` string
  - `TenantTags` string[] — Tags are referenced by CanonicalName like {TagSetName}/{TagName}

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)