Skip to content

Tenant programs: update, delete

The Tenant Verbs update, delete as MCP do programs, with inputs, result, refusals and an example.

Reference for Tenant, one group of Tenant programs.

Tenant.update

Changes the given properties of a Tenant. Verb page.

Text
do: return await $.Tenant.update(input)

Emits Tenant.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Tenant.
placementstringWhere the Tenant sits in an address: path or host.
apiVersionstringThe API version an unversioned call with this Tenant’s keys answers at; set at creation, moved only by pin.

Returns

OutputTypeRequiredDescription
tenantTenantrequiredThe Tenant.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Tenant.update({ id: 'ten_Bu63f0he26', placement: 'path' })"
  }
}

Tenant.delete

Deletes a Tenant: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
do: return await $.Tenant.delete(input)

Emits Tenant.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Tenant.

Returns

OutputTypeRequiredDescription
tenantTenantrequiredThe Tenant.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Tenant.delete({ id: 'ten_Bu63f0he26' })"
  }
}