Outline · Example Payload

Documentsdelete

Documents

Documentsdelete is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

{
  "operationId": "documentsDelete",
  "path": "/documents.delete",
  "method": "POST",
  "summary": "Delete a document",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "example": "hDYep1TPAM",
        "description": "Unique identifier for the document. Either the UUID or the urlId is acceptable."
      },
      "permanent": {
        "type": "boolean",
        "example": false,
        "description": "If set to true the document will be destroyed with no way to recover rather than moved to the trash."
      }
    },
    "required": [
      "id"
    ]
  }
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/documentsDelete"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.