Site methods: update, delete

Reference for Site, one group of Site methods.

Site.update

Changes the given properties of a Site. Verb page.

TypeScript

interface SiteVerbs {
  update(input: SiteUpdateInput, options?: SB.CallOptions): SB.Call<Site>
}

Emits Site.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Site.
`kind`	`string`		One of `api`, `mcp`, `cli`, `sdk`, `site`, `app`, `docs`, or `webhooks`.
`path`	`string`		Where it is mounted on its Domain, such as `/api`.
`conformsTo`	`json`		The Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.
`navigation`	`json`		The menus that link its Pages.

Returns

Output	Type	Required	Description
`site`	Site	required	The Site.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const site = await $.Site.update({ id: 'site_kqt1HxwFab', navigation: {} })

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

TypeScript

interface SiteVerbs {
  delete(input: SiteDeleteInput, options?: SB.CallOptions): SB.Call<Site>
}

Emits Site.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Site.

Returns

Output	Type	Required	Description
`site`	Site	required	The Site.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const site = await $.Site.delete({ id: 'site_kqt1HxwFab' })