patch https://{application_vanity_domain}/api/v1/tenants/
Patches the specified tenant.
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.
| Permission | Boundary | Description |
|---|---|---|
| tenant:update | Application | The subject can update any tenant in the application to which the subject belongs. |
| Tenant | The subject can update the tenant that it is associated with. | |
| Tenant Inclusion List | The subject can update the tenants specified in the inclusion list. | |
| Tenant Exclusion List | The subject can update the tenant only if it belongs to the subject's application and is not on the exclusion list. | |
| Self | The subject can update the tenant that it is associated with. |
Field-Level Permissions
In addition to the permissions above, the following permissions are required conditionally based on the fields being updated. The permission boundaries that apply to the tenant:update permission also apply to the field-level permissions.
| Permission | Description |
|---|---|
| tenant:manage-signup-enablement | Required if the signupEnabled field is modified. |
| tenant:manage-restricted-metadata | Required if the restrictedMetadata field is modified. |
| tenant:manage-status | Required if the state field is modified. |