Übersicht

Delete goal

POST/api/v1/delete_goal
Features

Archive a goal by name. Archived rather than destroyed, because a funnel step pointing at it would otherwise vanish — and a funnel that silently loses a step reports a BETTER conversion rate than the real one.

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/delete_goal.

Input1
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.
keystring · body
The goal's name.
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 attributes2
workspace_idnumber
archivedstring
The goal's key.
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/delete_goal' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example output
{
  "ok": true,
  "result": {
    "workspace_id": 0,
    "archived": "<archived>"
  },
  "duration_ms": 0
}

Aktualisiert

War diese Seite hilfreich?