capsule

Delete many capsules in a single call. A batch containing a capsule other capsules cite needs confirm_citations: true.

Changed on
post/api/preview/capsules/batch/delete

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/capsules/batch/delete
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Request body

capsuleIdsstring[] required

Capsule UUIDs to operate on

confirmOwnedLogboolean

Confirm deleting capsules that own a log (issue #2250). Without it, each such capsule fails with owned_log_present and owned_log naming the log and its entry count. Confirmed, the log is deleted with its owner when you may delete it, otherwise detached and kept. A log you may not read is never named: it is detached and kept, and the capsule does not fail for it.

confirm_citationsboolean

Set true to delete even when other capsules cite one of these; without it such a batch is refused with a 409 citations_confirmation_required naming the citing count and a sample. Sending false opts in to that refusal before its breaking-change effective date (issue #2259).

permanentboolean

Delete for good now instead of moving the capsules to Recently deleted, where they stay recoverable for 30 days (issue #2524). Also takes capsules already in Recently deleted.

Response

Successful response

failedobject[] required
succeededobject[] required

Changes