Funnel methods: update, delete
The Funnel Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Funnel, one group of Funnel methods.
Funnel.update
Changes the given properties of a Funnel. Verb page.
interface FunnelVerbs {
update(input: FunnelUpdateInput, options?: SB.CallOptions): SB.Call<Funnel>
}Emits Funnel.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Funnel. |
steps | json | The Pages, Forms, and Sequences in order. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
funnel | Funnel | required | The Funnel. |
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 funnel = await $.Funnel.update({ id: 'funnel_nXbfyw7dTw', steps: {} })Funnel.delete
Deletes a Funnel: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface FunnelVerbs {
delete(input: FunnelDeleteInput, options?: SB.CallOptions): SB.Call<Funnel>
}Emits Funnel.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Funnel. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
funnel | Funnel | required | The Funnel. |
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 funnel = await $.Funnel.delete({ id: 'funnel_nXbfyw7dTw' })