---
title: "Update a template"
method: POST
path: "/templates.update"
tags: ["Templates"]
---

# Update a template

`POST /templates.update`

## Request

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

Update an existing template by its unique identifier.

## Request body

- object
  - `id` string, required: Unique identifier for the template. Either the UUID or the urlId is acceptable.
  - `title` string: The title of the template.
  - `data` object: The body of the template as a Prosemirror document.
  - `icon` string, nullable: An emoji to use as the template icon.
  - `color` string, nullable: The color of the template icon in hex format.
  - `fullWidth` boolean: Whether the template should be displayed full width.
  - `collectionId` string, uuid, nullable: Identifier for the collection to which the template belongs. Set to null for a workspace-wide template.
  - `publish` boolean: Set to true to publish a draft template so it becomes available to other members.

## Response `200`

OK

- object
  - `data` Template
    - `id` string, uuid: Unique identifier for the object.
    - `url` string: A URL path to access the template. Deprecated – prefer the `path` field.
    - `path` string: A URL path to access the template.
    - `urlId` string: A short unique identifier for the template used in URLs.
    - `title` string: The title of the template.
    - `data` object: The body of the template as a Prosemirror document.
    - `icon` string, nullable: An emoji to use as the template icon.
    - `color` string, nullable: The color of the template icon in hex format.
    - `fullWidth` boolean: Whether the template should be displayed full width.
    - `collectionId` string, uuid, nullable: Identifier for the associated collection, if any.
    - `createdAt` string, date-time: The date and time that the template was created.
    - `createdBy` User
      - `id` string, uuid: Unique identifier for the object.
      - `name` string: The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `avatarUrl` string, uri: The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `color` string: A color representing the user, used in the UI for avatars without an image.
      - `email` string, email: The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean: Whether this user has been suspended.
      - `lastActiveAt` string, date-time, nullable: The last time this user made an API request, this value is updated at most every 5 minutes.
      - `timezone` string, nullable: The timezone this user has registered.
      - `createdAt` string, date-time: The date and time that this user first signed in or was invited as a guest.
      - `updatedAt` string, date-time: The date and time that this user was last updated.
      - `deletedAt` string, date-time, nullable: The date and time that this user was deleted, if applicable.
      - `invitedBy` User (recursive)
    - `updatedAt` string, date-time: The date and time that the template was last changed.
    - `updatedBy` User
      - `id` string, uuid: Unique identifier for the object.
      - `name` string: The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `avatarUrl` string, uri: The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `color` string: A color representing the user, used in the UI for avatars without an image.
      - `email` string, email: The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if necessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean: Whether this user has been suspended.
      - `lastActiveAt` string, date-time, nullable: The last time this user made an API request, this value is updated at most every 5 minutes.
      - `timezone` string, nullable: The timezone this user has registered.
      - `createdAt` string, date-time: The date and time that this user first signed in or was invited as a guest.
      - `updatedAt` string, date-time: The date and time that this user was last updated.
      - `deletedAt` string, date-time, nullable: The date and time that this user was deleted, if applicable.
      - `invitedBy` User (recursive)
    - `deletedAt` string, date-time, nullable: The date and time that the template was deleted.
    - `publishedAt` string, date-time, nullable: The date and time that the template was published.
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## Other responses

- `400`: The request failed one or more validations.
- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `404`: The specified resource was not found.
- `429`: The request was rate limited.

## Changes

- **2026-11-02** `5ddf01ffba84`: 2 info
  - added the optional property `data/path` to the response with the `200` status
  - response property `data/url` deprecated
- **2026-08-12** `1a5abc8eeaaf`: 1 info
  - added the new optional request property `publish`
- **2026-08-12** `9a99ee93e11d`: 2 info
  - added the optional property `data/createdBy/invitedBy` to the response with the `200` status
  - added the optional property `data/updatedBy/invitedBy` to the response with the `200` status
- **2026-05-30** `304cd065561b`: 3 breaking, 8 info
  - the response property `data/createdBy/lastActiveAt` became nullable for the status `200`
  - the response property `data/publishedAt` became nullable for the status `200`
  - the response property `data/updatedBy/lastActiveAt` became nullable for the status `200`
  - added the optional property `data/createdBy/color` to the response with the `200` status
  - …7 more
- **2026-02-22** `ef19c13ebedf`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/templates.update/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)