Skip to content

Task methods: update, delete

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

Reference for Task, one group of Task methods.

Task.update

Changes the given properties of a Task. Verb page.

TypeScript
interface TaskVerbs {
  update(input: TaskUpdateInput, options?: SB.CallOptions): SB.Call<Task>
}

Emits Task.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Task.
byWorkerThe Worker that performed it.
forPartyThe Party it was done on behalf of.
viastringThe Interface or request it arrived through.
onstringThe Action or Event that caused it, such as the failed attempt a retry follows.
thingstringThe record, at the Version the Action was decided against.
inputjsonThe input it was called with.
createdAtdatetimeWhen it was called.
reservedmoneyThe most this Action may cost, held against its Limits from the check until it settles, billed misses included.
duedatetimeWhen the Task is due.
priorityintegerIts rank in the inbox, highest first.
recurrencestringThe schedule a recurring duty repeats on.

Returns

OutputTypeRequiredDescription
taskTaskrequiredThe Task.

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 task = await $.Task.update({ id: 'task_tVPKjporKn', due: '2026-10-22T12:00:00Z' })

Task.delete

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

TypeScript
interface TaskVerbs {
  delete(input: TaskDeleteInput, options?: SB.CallOptions): SB.Call<Task>
}

Emits Task.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Task.

Returns

OutputTypeRequiredDescription
taskTaskrequiredThe Task.

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 task = await $.Task.delete({ id: 'task_tVPKjporKn' })