--- title: "Update workspace settings" method: PUT path: "/workspace/{workspace_id}/settings" tags: ["Workspace Settings"] --- # Update workspace settings `PUT /workspace/{workspace_id}/settings` Update workspace settings ## Path parameters - `workspace_id` string, uuid, required ## Request body - object - `signing_request_email_header` string - `signing_request_email_body` string - `team_email` string, email - `timezone` string - `language` 'en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' — Workspace language for email templates - `show_credit_cost_in_editor` boolean — Whether to display credit cost in embedded editors - `require_otp_verification` boolean, nullable — Whether signers must verify their email via OTP. null = inherit from company - `require_terms_acceptance` boolean, nullable — Whether signers must accept terms before signing. null inherits the company-level setting. - `disable_guided_navigation` boolean, nullable — Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set. - `show_signature_frame` boolean, nullable — Whether to render signature frames in completed PDFs. null = inherit from company - `color_primary` string, nullable — Primary color override (#rrggbb hex). Null to inherit from company. - `color_primary_fg` string, nullable — Primary foreground color override. Null to inherit from company. - `color_background` string, nullable — Background color override. Null to inherit from company. - `color_foreground` string, nullable — Foreground/text color override. Null to inherit from company. - `color_card` string, nullable — Card background color override. Null to inherit from company. - `color_border` string, nullable — Border color override. Null to inherit from company. - `color_accent` string, nullable — Editor chrome accent color. Null to inherit from company. - `color_accent_fg` string, nullable — Foreground color on accent surfaces. Null to inherit from company. - `color_canvas` string, nullable — Editor document-canvas surround color. Null to inherit from company. - `color_muted` string, nullable — Muted surface color. Null to inherit from company. - `color_muted_fg` string, nullable — Muted text color. Null to inherit from company. - `email_local_part` string, nullable — The local-part (before the @) of the sender email address. Null to inherit from company setting. - `allow_presigning_download` boolean, nullable — Allow signers to download the original document before signing. Inherits from workspace or company setting when null. - `show_partial_watermark` boolean, nullable — Show an IN PROGRESS watermark on partial PDF downloads when not all signers have completed. null inherits the company-level setting. - `show_qr_code` boolean, nullable — Show a QR code on the signing page that lets signers continue on their phone. Inherits from workspace or company setting when null. - `signing_button_label_overrides` object, 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_title` string, nullable — Heading shown on the completion page after signing. Null (or an empty string) clears the override and inherits from company. - `completion_message` string, nullable — Body text shown on the completion page after signing. Null (or an empty string) clears the override and inherits from company. - `completion_redirect_url` string, uri, nullable — URL the signer is redirected to from the completion page. Must use https://. Null (or an empty string) clears the override and inherits from company. - `completion_redirect_delay` integer, nullable — Seconds the completion page waits before redirecting (0 redirects immediately). Only applies when a redirect URL resolves. Null clears the override and inherits from company. ## Response `200` Workspace settings updated successfully - WorkspaceSettings - `workspace_id` string, uuid, required - `name` string — Workspace name - `team_email` string, email — Workspace contact email - `timezone` string — Workspace timezone - `language` 'en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' — Workspace language for email templates - `signing_request_email_header` string — Custom email header text - `signing_request_email_body` string — Custom HTML email body - `show_credit_cost_in_editor` boolean — Whether to display credit cost in embedded template and signing request editors - `require_otp_verification` boolean, 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_acceptance` boolean, nullable — Whether signers must accept terms before signing. null inherits the company-level setting. - `disable_guided_navigation` boolean, nullable — Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set. - `show_signature_frame` boolean, 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_download` boolean, nullable — Allow signers to download the original document before signing. null inherits the company-level setting. - `show_partial_watermark` boolean, nullable — Show an IN PROGRESS watermark on partial PDF downloads when not all signers have completed. null inherits the company-level setting. - `show_qr_code` boolean, nullable — Show a QR code on the signing page that lets signers continue on their phone. null inherits the company-level setting. - `color_primary` string, nullable — Primary color override (#rrggbb hex). Null to inherit from company. - `color_primary_fg` string, nullable — Primary foreground color override. Null to inherit. - `color_background` string, nullable — Background color override. Null to inherit. - `color_foreground` string, nullable — Foreground/text color override. Null to inherit. - `color_card` string, nullable — Card background color override. Null to inherit. - `color_border` string, nullable — Border color override. Null to inherit. - `color_accent` string, nullable — Editor chrome accent color. Null to inherit. - `color_accent_fg` string, nullable — Foreground color on accent surfaces. Null to inherit. - `color_canvas` string, nullable — Editor document-canvas surround color. Null to inherit. - `color_muted` string, nullable — Muted surface color. Null to inherit. - `color_muted_fg` string, nullable — Muted text color. Null to inherit. - `email_local_part` string, 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_overrides` object, 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_title` string, 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_message` string, 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_url` string, 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_delay` integer, 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. ## Other responses - `400` — Bad Request - Validation failed - `401` — Unauthorized - Invalid or missing API key - `404` — Not Found - Resource does not exist - `429` — Too Many Requests - Rate limit exceeded --- [API](https://skmtc.dev/firma/apis/firma-partner-api.md) · [All operations](https://skmtc.dev/firma/apis/firma-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firma/firma-partner-api/revisions/5c03d6a9d080/schema)