Atlassian · Schema

ContentTemplateUpdate

This object is used to update content templates.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
templateId string The ID of the template being updated.
name string The name of the template. Set to the current `name` if this field is not being updated.
templateType string The type of the template. Set to `page`.
body object
description string A description of the template.
labels array Labels for the template.
space object The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.
View JSON Schema on GitHub

JSON Schema

atlassian-contenttemplateupdate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentTemplateUpdate",
  "title": "ContentTemplateUpdate",
  "required": [
    "body",
    "name",
    "templateId",
    "templateType"
  ],
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "templateId": {
      "type": "string",
      "description": "The ID of the template being updated."
    },
    "name": {
      "type": "string",
      "description": "The name of the template. Set to the current `name` if this field is\nnot being updated."
    },
    "templateType": {
      "type": "string",
      "description": "The type of the template. Set to `page`.",
      "enum": [
        "page"
      ]
    },
    "body": {
      "$ref": "#/components/schemas/ContentTemplateBodyCreate"
    },
    "description": {
      "maxLength": 100,
      "type": "string",
      "description": "A description of the template."
    },
    "labels": {
      "type": "array",
      "description": "Labels for the template.",
      "items": {
        "$ref": "#/components/schemas/Label"
      }
    },
    "space": {
      "required": [
        "key"
      ],
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "properties": {
        "key": {
          "type": "string"
        }
      },
      "description": "The key for the space of the template. Required if the template is a\nspace template. Set this to the current `space.key`."
    }
  },
  "description": "This object is used to update content templates."
}