Skip to content

Content methods: update, delete

The Content Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.

Reference for Content, one group of Content methods.

Content.update

Changes the given properties of a Content. Verb page.

TypeScript
interface ContentVerbs {
  update(input: ContentUpdateInput, options?: SB.CallOptions): SB.Call<Content>
}

Emits Content.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Content.
titlestringThe headline.
publishedAtdatetimeWhen it went live.
kindstringWhat the Content is, so each System reads its own kind.

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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

TypeScript
import { $ } from 'startup-builder'

const content = await $.Content.update({ id: 'content_HYlnoorBdP', title: 'Leaseline Pro' })

Content.delete

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

TypeScript
interface ContentVerbs {
  delete(input: ContentDeleteInput, options?: SB.CallOptions): SB.Call<Content>
}

Emits Content.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Content.

Returns

OutputTypeRequiredDescription
contentContentrequiredThe Content.

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

TypeScript
import { $ } from 'startup-builder'

const content = await $.Content.delete({ id: 'content_HYlnoorBdP' })