Skip to content

Funnel commands: update, delete

The Funnel Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Funnel, one group of Funnel commands.

Funnel.update

Changes the given properties of a Funnel. Verb page.

Text
npx startup-builder do Funnel.update --json '<input>' [--try | --send | --do]

Emits Funnel.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Funnel.
stepsjsonThe Pages, Forms, and Sequences in order.

Returns

OutputTypeRequiredDescription
funnelFunnelrequiredThe Funnel.

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

Terminal
npx startup-builder do Funnel.update --json '{"id":"funnel_nXbfyw7dTw","steps":{}}'

Funnel.delete

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

Text
npx startup-builder do Funnel.delete --json '<input>' [--try | --send | --do]

Emits Funnel.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Funnel.

Returns

OutputTypeRequiredDescription
funnelFunnelrequiredThe Funnel.

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

Terminal
npx startup-builder do Funnel.delete --json '{"id":"funnel_nXbfyw7dTw"}'