Funnel routes: update, delete

Reference for Funnel, one group of Funnel routes.

Funnel.update

Changes the given properties of a Funnel. Verb page.

Text

PATCH /{namespace}/funnels/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/funnels/funnel_nXbfyw7dTw \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "funnel": {
    "$id": "https://api.sb/leaseline.app/funnels/funnel_nXbfyw7dTw",
    "$type": "Funnel",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Funnel.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Funnel.delete

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