---
title: "Update footer comment"
method: PUT
path: "/footer-comments/{comment-id}"
tags: ["Comment"]
---

# Update footer comment

`PUT /footer-comments/{comment-id}`

Update a footer comment. This can be used to update the body text of a comment.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.

## Path parameters

- `comment-id` integer, required

## Request body

- object
  - `version` object
    - `number` integer — Number of new version. Should be 1 higher than current version of the comment.
    - `message` string — Optional message store for the new version.
  - `body` union
    - CommentBodyWrite
      - `representation` 'storage' | 'atlas_doc_format' | 'wiki' — Type of content representation used for the value field.
      - `value` string — Body of the comment, in the format found in the representation field.
    - CommentNestedBodyWrite — Body of the comment. Only one body format should be specified as the property for this object, e.g. `storage`.
      - `storage` CommentBodyWrite
        - `representation` 'storage' | 'atlas_doc_format' | 'wiki' — Type of content representation used for the value field.
        - `value` string — Body of the comment, in the format found in the representation field.
      - `atlas_doc_format` CommentBodyWrite
        - `representation` 'storage' | 'atlas_doc_format' | 'wiki' — Type of content representation used for the value field.
        - `value` string — Body of the comment, in the format found in the representation field.
      - `wiki` CommentBodyWrite
        - `representation` 'storage' | 'atlas_doc_format' | 'wiki' — Type of content representation used for the value field.
        - `value` string — Body of the comment, in the format found in the representation field.
  - `_links` object
    - `base` string — Base url of the Confluence site.

## Response `200`

Returned if the footer comment is updated successfully

- FooterCommentModel
  - `id` string — ID of the comment.
  - `status` 'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any' — The status of the content.
  - `title` string — Title of the comment.
  - `blogPostId` string — ID of the blog post containing the comment if the comment is on a blog post.
  - `pageId` string — ID of the page containing the comment if the comment is on a page.
  - `attachmentId` string — ID of the attachment containing the comment if the comment is on an attachment.
  - `customContentId` string — ID of the custom content containing the comment if the comment is on a custom content.
  - `parentCommentId` string — ID of the parent comment if the comment is a reply.
  - `version` Version
    - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
    - `message` string — Message associated with the current version.
    - `number` integer — The version number.
    - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
    - `authorId` string — The account ID of the user who created this version.
  - `properties` object
    - `results` ContentProperty[]
      - `id` string — ID of the property
      - `key` string — Key of the property
      - `value` unknown
      - `version` Version
        - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
        - `message` string — Message associated with the current version.
        - `number` integer — The version number.
        - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
        - `authorId` string — The account ID of the user who created this version.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `operations` object
    - `results` Operation[]
      - `operation` string — The type of operation.
      - `targetType` string — The type of entity the operation type targets.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `likes` object
    - `results` Like[]
      - `accountId` string — Account ID.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `versions` object
    - `results` Version[]
      - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
      - `message` string — Message associated with the current version.
      - `number` integer — The version number.
      - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
      - `authorId` string — The account ID of the user who created this version.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `body` BodySingle — Contains fields for each representation type requested.
    - `storage` BodyType
      - `representation` string — Type of content representation used for the value field.
      - `value` string — Body of the content, in the format found in the representation field.
    - `atlas_doc_format` BodyType
      - `representation` string — Type of content representation used for the value field.
      - `value` string — Body of the content, in the format found in the representation field.
    - `view` BodyType
      - `representation` string — Type of content representation used for the value field.
      - `value` string — Body of the content, in the format found in the representation field.
  - `_links` CommentLinks
    - `webui` string — Web UI link of the content.

## Other responses

- `400` — Returned if an invalid request is provided
- `401` — Returned if the authentication credentials are incorrect or missing from the request.
- `404` — Returned if: - The comment was not found - The calling user does not have permission to view the comment - The user is forbidden from updating a comment tied to a resource they are allowed to view

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api-v2/revisions/c4bd1ed570f2/schema)