workspace_idstring uuid required
language'en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb'
Workspace language for email templates
signing_request_email_headerstring
signing_request_email_bodystring
show_credit_cost_in_editorboolean
Whether to display credit cost in embedded template and signing request editors
require_otp_verificationboolean nullable
Whether signers must verify their email via OTP before accessing documents. null = inherit from company setting, true = require OTP, false = do not require OTP
require_terms_acceptanceboolean nullable
Whether signers must accept terms before signing. null inherits the company-level setting.
disable_guided_navigationboolean nullable
Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set.
show_signature_frameboolean nullable
Whether to render a visual frame with Signature ID around signatures in completed PDFs. null = inherit from company setting (default enabled), true = show frame, false = hide frame
allow_presigning_downloadboolean nullable
Allow signers to download the original document before signing. null inherits the company-level setting.
show_partial_watermarkboolean nullable
Show an IN PROGRESS watermark on partial PDF downloads when not all signers have completed. null inherits the company-level setting.
show_qr_codeboolean nullable
Show a QR code on the signing page that lets signers continue on their phone. null inherits the company-level setting.
color_primarystring nullable
Primary color override (#rrggbb hex). Null to inherit from company.
color_primary_fgstring nullable
Primary foreground color override. Null to inherit.
color_backgroundstring nullable
Background color override. Null to inherit.
color_foregroundstring nullable
Foreground/text color override. Null to inherit.
color_cardstring nullable
Card background color override. Null to inherit.
color_borderstring nullable
Border color override. Null to inherit.
color_accentstring nullable
Editor chrome accent color. Null to inherit.
color_accent_fgstring nullable
Foreground color on accent surfaces. Null to inherit.
color_canvasstring nullable
Editor document-canvas surround color. Null to inherit.
color_mutedstring nullable
Muted surface color. Null to inherit.
color_muted_fgstring nullable
Muted text color. Null to inherit.
email_local_partstring nullable
The local-part (before the @) of the sender email address. Null to inherit from company setting. Only applies when a verified custom domain is configured.
signing_button_label_overridesobject nullable
Per-language custom button labels for the signing view. Keys are language codes (en, de, etc.); values are objects mapping translation keys to custom text. Null to use defaults.
completion_titlestring nullable
Heading shown on the completion page after signing. Null inherits the company-level setting; the built-in translated heading is used when unset at every level.
completion_messagestring nullable
Body text shown on the completion page after signing. Null inherits the company-level setting; the built-in translated message is used when unset at every level.
completion_redirect_urlstring uri nullable
URL the signer is redirected to from the completion page. Must use https://. Null inherits the company-level setting; no redirect happens when unset at every level. The completion page only honors this server-resolved URL.
completion_redirect_delayinteger nullable
Seconds the completion page waits before redirecting (0 redirects immediately). Only applies when a redirect URL resolves. Null inherits the company-level setting; the page falls back to 5 seconds when unset at every level.