Sigma REST APIOrganizationscomments

Update the comment settings for an organization

View as Markdown
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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
enabledbooleanOptional
Whether users in the organization can comment on documents.
allowAnnotationsbooleanOptional
Whether users can capture images and annotate them in comments. Can only set if commenting is enabled.
annotationRetentionDaysdoubleOptional

How long annotation images are kept, in days. Must be between 1 and 730 (two years).

Response

The response body.
enabledboolean
Whether users in the organization can comment on documents.
allowAnnotationsboolean
Whether users can capture images and annotate them in comments. Can only set if commenting is enabled.
annotationRetentionDaysdouble

How long annotation images are kept, in days. Must be between 1 and 730 (two years).