PUT /wiki/rest/api/template
Updates a content template. Note, blueprint templates cannot be updated via the REST API.
Permissions required: 'Admin' permission for the space to update a space template or 'Confluence Administrator' global permission to update a global template.
Servers
- https://your-domain.atlassian.net
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
templateId |
String | Yes |
The ID of the template being updated. |
name |
String | Yes |
The name of the template. Set to the current |
space |
Object | No |
The key for the space of the template. Required if the template is a
space template. Set this to the current |
space.key |
String | Yes | |
description |
String | No |
A description of the template. |
labels[] |
Array | No |
Labels for the template. |
labels[].id |
String | Yes | |
labels[].prefix |
String | Yes | |
labels[].name |
String | Yes | |
labels[].label |
String | Yes | |
body |
Object | Yes |
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. Note, |
body.export_view |
Object | No |
This object is used when creating or updating content. |
body.export_view.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.export_view.value |
String | Yes |
The body of the content in the relevant format. |
body.styled_view |
Object | No |
This object is used when creating or updating content. |
body.styled_view.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.styled_view.value |
String | Yes |
The body of the content in the relevant format. |
body.storage |
Object | No |
This object is used when creating or updating content. |
body.storage.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.storage.value |
String | Yes |
The body of the content in the relevant format. |
body.editor2 |
Object | No |
This object is used when creating or updating content. |
body.editor2.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.editor2.value |
String | Yes |
The body of the content in the relevant format. |
body.wiki |
Object | No |
This object is used when creating or updating content. |
body.wiki.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.wiki.value |
String | Yes |
The body of the content in the relevant format. |
body.anonymous_export_view |
Object | No |
This object is used when creating or updating content. |
body.anonymous_export_view.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.anonymous_export_view.value |
String | Yes |
The body of the content in the relevant format. |
body.atlas_doc_format |
Object | No |
This object is used when creating or updating content. |
body.atlas_doc_format.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.atlas_doc_format.value |
String | Yes |
The body of the content in the relevant format. |
body.view |
Object | No |
This object is used when creating or updating content. |
body.view.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.view.value |
String | Yes |
The body of the content in the relevant format. |
body.editor |
Object | No |
This object is used when creating or updating content. |
body.editor.representation |
String | Yes |
The content format type. Set the value of this property to the name of the format being used, e.g. 'storage'. Possible values:
|
body.editor.value |
String | Yes |
The body of the content in the relevant format. |
templateType |
String | Yes |
The type of the template. Set to Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.