DEdefaulr
Templates

Update a template

Changed on

Update an existing template by its unique identifier.

post/templates.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/templates.update
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring required

Unique identifier for the template. Either the UUID or the urlId is acceptable.

titlestring

The title of the template.

dataobject

The body of the template as a Prosemirror document.

iconstring nullable

An emoji to use as the template icon.

colorstring nullable

The color of the template icon in hex format.

fullWidthboolean

Whether the template should be displayed full width.

collectionIdstring uuid nullable

Identifier for the collection to which the template belongs. Set to null for a workspace-wide template.

publishboolean

Set to true to publish a draft template so it becomes available to other members.

Response

OK

Example response

{
  "data": {
    "createdBy": {
      "name": "Jane Doe"
    },
    "updatedBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes