Outline · Example Payload

Templatescreate

Templates

Templatescreate 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": "templatesCreate",
  "path": "/templates.create",
  "method": "POST",
  "summary": "Create a template",
  "tags": [
    "Templates"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uuid",
        "description": "Optionally provide a specific UUID for the template."
      },
      "title": {
        "type": "string",
        "description": "The title of the template.",
        "minLength": 1,
        "maxLength": 255
      },
      "data": {
        "type": "object",
        "description": "The body of the template as a Prosemirror document."
      },
      "icon": {
        "type": "string",
        "description": "An emoji to use as the template icon.",
        "nullable": true
      },
      "color": {
        "type": "string",
        "description": "The color of the template icon in hex format.",
        "nullable": true,
        "pattern": "^#[0-9A-Fa-f]{6}$"
      },
      "collectionId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the collection to which the template belongs."
      }
    },
    "required": [
      "title",
      "data"
    ]
  }
}