Outline · Example Payload

Documentstemplatize

Documents

Documentstemplatize 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

Raw ↑ 
{
  "operationId": "documentsTemplatize",
  "path": "/documents.templatize",
  "method": "POST",
  "summary": "Create a template from a document",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid"
      },
      "collectionId": {
        "type": "string",
        "format": "uuid",
        "nullable": true,
        "description": "Identifier for the collection where the template should be created"
      },
      "publish": {
        "type": "boolean",
        "description": "Whether the new template should be published"
      }
    },
    "required": [
      "id",
      "publish"
    ]
  }
}