---
title: "Update the comment settings for an organization"
method: PATCH
path: "/v2/organizations/settings/comments"
tags: ["Organizations"]
---

# Update the comment settings for an organization

`PATCH /v2/organizations/settings/comments`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/organizations/settings/comments`
- Auth: HTTP bearer

Update the comment and image annotation settings for an organization.


### Usage notes
- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.

## Request body

- object
  - `enabled` boolean: Whether users in the organization can comment on documents.
  - `allowAnnotations` boolean: Whether users can capture images and annotate them in comments. Can only set if commenting is enabled.
  - `annotationRetentionDays` number, double: How long annotation images are kept, in days. Must be between 1 and 730 (two years).

## Response `200`

The response body.

- OrganizationsUpdateCommentsSettingsResponse200
  - `enabled` boolean, required: Whether users in the organization can comment on documents.
  - `allowAnnotations` boolean, required: Whether users can capture images and annotate them in comments. Can only set if commenting is enabled.
  - `annotationRetentionDays` number, double, required: How long annotation images are kept, in days. Must be between 1 and 730 (two years).

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)