Mark path as funnel step

POST/api/v1/mark_path_as_funnel_step

Features

Add a documentation PAGE to a funnel as its next step, creating the page goal if it does not exist yet. The shortcut for 'this page is part of the route readers should take' — it saves creating a goal and then editing the funnel. Creates the funnel too if the name is new. Note the broad-entry rule: if this is the FIRST step of a new funnel you will get a warning, because a single page as step 1 excludes every reader who arrived deep.

Price — $0.00001 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/mark_path_as_funnel_step.

Input3

Authorizationheaderrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.

pathstring · body

The doc path, e.g. '/docs/quickstart'.

funnelstring · body

Funnel name to append the step to. Created if it does not exist.

positionnumber · body

0-based index to insert at. Appends when omitted.

Output3

okboolean

Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers 200 with ok: false: the call was made and billed, and that refusal is its answer.

resultobject

The tool's own JSON answer, already parsed — not a string to parse a second time.

Show child attributes5

workspace_idnumber

funnelobject

goalstring

issuesobject[]

unchangedstring

duration_msinteger

Server-side wall time for the call.

Responses

200The tool ran. Read ok to see whether it succeeded.

401Missing or invalid API key.

Example input

curl -X POST 'https://docsbook.io/api/v1/mark_path_as_funnel_step' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example output

{
  "ok": true,
  "result": {
    "workspace_id": 0,
    "funnel": {},
    "goal": "<goal>",
    "issues": [],
    "unchanged": "<unchanged>"
  },
  "duration_ms": 0
}

更新于 Sep 24, 2026