Interface ContentTemplateUpdate

This object is used to update content templates.

interface ContentTemplateUpdate {
    body: ContentTemplateBodyCreate;
    description?: string;
    labels?: LabelV1[];
    name: string;
    space?: null | {
        key: string;
    } & {
        [key: string]: unknown;
    };
    templateId: string;
    templateType: "page";
}

Hierarchy

  • Record<string, unknown>
    • ContentTemplateUpdate

Properties

body description? labels? name space? templateId templateType

Properties

body

body: ContentTemplateBodyCreate

The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage.

Note, editor2 format is used by Atlassian only. anonymous_export_view is the same as export_view format but only content viewable by an anonymous user is included.

Optionaldescription

description?: string

A description of the template.

Optionallabels

labels?: LabelV1[]

Labels for the template.

name

name: string

The name of the template. Set to the current name if this field is not being updated.

Optionalspace

space?: null | {
    key: string;
} & {
    [key: string]: unknown;
}

The key for the space of the template. Required if the template is a space template. Set this to the current space.key.

templateId

templateId: string

The ID of the template being updated.

templateType

templateType

The type of the template. Set to page.

Settings

Member Visibility

On This Page

Properties