概览

Revoke claim link

POST/api/v1/revoke_claim_link
Features

Cancel this project's pending claim link before anyone claims it — 'take the link back', 'cancel the transfer', «отмени claim-ссылку».

Price — free, never metered.

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

Input0
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.
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 attributes4
okboolean
workspace_idnumber
statestring
revoked — or claimed, when the hand-over had already completed.
revokednumber
How many pending links were cancelled (one, by construction).
duration_msinteger
Server-side wall time for the call.
Limitations
  • Only a link that is still pending can be revoked: a claimed one is a completed hand-over, and the result then reports state: claimed with who took it.
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/revoke_claim_link' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'
Example output
{
  "ok": true,
  "result": {
    "ok": true,
    "workspace_id": 0,
    "state": "<state>",
    "revoked": 0
  },
  "duration_ms": 0
}

更新于

此页面对您有帮助吗?