PATCH /public/v2/documents/{document_id}/settings

Updates the settings for a specified document. Supported fields: language, qualified_electronic_signature, expires_in (in days).

Servers

Path parameters

Name Type Required Description
document_id String Yes

Unique identifier of the document to update settings for.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
expires_in Integer No

Document expiration in days. Minimum is 1 day.

qualified_electronic_signature Boolean No

Indicates whether the document requires a Qualified Electronic Signature (QES) during the signing process. If true, signers must complete the document using a third-party qualified electronic signature provider according to supported verification rules.

language String No

Document language code (e.g., 'en-US', 'fr-FR').

Valid values:

  • "es-ES"
  • "pt-BR"
  • "hu-HU"
  • "nl-NL"
  • "el-GR"
  • "fr-FR"
  • "da-DK"
  • "nb-NO"
  • "de-DE"
  • "pl-PL"
  • "sv-SE"
  • "it-IT"
  • "en-US"
  • "bg-BG"
  • "ro-RO"
  • "pt-PT"
  • "cs-CZ"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.