Settings

Update the document settings

PATCH/settings/documents
documents:writeupdate_document_settingsIdempotent

Changes the organisation-wide document settings and returns them all. Send only the switches you change. Unlike the platform screens, this needs the document settings permission. Changes apply to every document straight away. dry_run shows the result without saving. Emits document_settings.updated when something changed; sends no email. Sending the old values undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · DocumentSettingsUpdate

  • folder_visibilityobject#

    Send only the switches you change.

  • document_countering_enabledboolean#

    Whether documents can be set to need countersigning. Each document then has its own countersigning switch.

  • signaturesobject#

    Send only the switches you change.

  • watermarkingobject#

    Send only the switches you change.

{
  "watermarking": {
    "investors": true
  }
}

Responses

200

The document settings after the change.

DocumentSettings
{
  "data": {
    "folder_visibility": {
      "hide_deal_information": true,
      "hide_pre_investment": true,
      "hide_portfolio_tab_for_investors": true,
      "hide_portfolio_tab_for_internal_users": true
    },
    "document_countering_enabled": true,
    "signatures": {
      "allow_editing_investor_name": true,
      "autofill_investor_name": true,
      "replace_certificate_qr_code_with_hash": true
    },
    "watermarking": {
      "investors": true,
      "internal_users": true,
      "entrepreneurs": true,
      "advisors": true
    }
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/settings/documents\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "watermarking": {
    "investors": true
  }
}'