Skip to main content

tenantUpdate

Updates an existing tenant with new configuration data. Non-admin/internal callers may only update their own tenant; passing a different id throws TENANT_FORBIDDEN_ERROR.

Errors: TENANT_UPDATE_ERROR, TENANT_FORBIDDEN_ERROR, TENANT_NOT_FOUND_ERROR if tenant doesn't exist.

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

tenantUpdate(
  input: TenantUpdateInput!
  id: String
): Tenant!

Arguments​

tenantUpdate.input ● TenantUpdateInput! non-null input​

Updated tenant configuration data. Only provided fields will be updated, others remain unchanged.

tenantUpdate.id ● String scalar​

Unique identifier of the tenant to update. If not provided, uses current user's tenant context.

Type​

Tenant object​

Represents a tenant - the top-level organizational unit in the system. Tenants contain channels and have their own configuration settings.