Thread methods: update, delete
The Thread Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Thread, one group of Thread methods.
Thread.update
Changes the given properties of a Thread. Verb page.
interface ThreadVerbs {
update(input: ThreadUpdateInput, options?: SB.CallOptions): SB.Call<Thread>
}Emits Thread.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Thread. |
subject | string | What the Thread is about. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
thread | Thread | required | The Thread. |
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
import { $ } from 'startup-builder'
const thread = await $.Thread.update({ id: 'thread_GzIHRhK100', subject: 'Example subject' })Thread.delete
Deletes a Thread: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface ThreadVerbs {
delete(input: ThreadDeleteInput, options?: SB.CallOptions): SB.Call<Thread>
}Emits Thread.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Thread. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
thread | Thread | required | The Thread. |
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
import { $ } from 'startup-builder'
const thread = await $.Thread.delete({ id: 'thread_GzIHRhK100' })