Organizations

Update the comment settings for an organization

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 to obtain a token for that tenant, then call this endpoint with that token.
patch/v2/organizations/settings/comments

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request 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.

annotationRetentionDaysnumber double

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

Response

The response body.

enabledboolean required

Whether users in the organization can comment on documents.

allowAnnotationsboolean required

Whether users can capture images and annotate them in comments. Can only set if commenting is enabled.

annotationRetentionDaysnumber double required

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

Changes

No recorded changes to this operation across all 1 revision of this API.