Skip to content
Last updated

Finalize confirmation dialog

Before a document is finalized, the Builder UI shows a confirmation dialog. By default it displays a generic confirmation message:

Default finalize confirmation dialog

You can control this dialog with the finalization object when creating or updating a builder session.

How to use:

  1. Create a builder session with a finalization object in POST /api/builder/sessions (endpoint docs), or update an existing session via PATCH /api/builder/sessions/{session_id} (endpoint docs).
  2. Set confirmation_enabled to control whether the confirmation dialog is shown before finalization.
  3. Optionally set confirmation_text to replace the default message with your own. HTML is supported with the allowed tags strong, b, and wbr. When omitted, the default confirmation copy is used.
{
  "finalization": {
    "confirmation_enabled": true,
    "confirmation_text": "<strong>Please review carefully.</strong> This action cannot be undone."
  }
}

When trial mode is enabled (trial is not null), finalization settings are ignored. Set finalization to null via PATCH /api/builder/sessions/{session_id} to clear previously set finalization settings and restore the default dialog.