Skip to main content
PUT
/
workspace
/
{workspace_id}
/
settings
Update workspace settings
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signing_request_email_header": "<string>",
  "signing_request_email_body": "<string>",
  "team_email": "jsmith@example.com",
  "timezone": "<string>",
  "show_credit_cost_in_editor": true,
  "require_otp_verification": true,
  "require_terms_acceptance": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "color_primary": "<string>",
  "color_primary_fg": "<string>",
  "color_background": "<string>",
  "color_foreground": "<string>",
  "color_card": "<string>",
  "color_border": "<string>",
  "color_accent": "<string>",
  "color_accent_fg": "<string>",
  "color_canvas": "<string>",
  "color_muted": "<string>",
  "color_muted_fg": "<string>",
  "email_local_part": "<string>"
}
'
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "team_email": "jsmith@example.com",
  "timezone": "<string>",
  "language": "en",
  "signing_request_email_header": "<string>",
  "signing_request_email_body": "<string>",
  "show_credit_cost_in_editor": true,
  "require_otp_verification": true,
  "require_terms_acceptance": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "color_primary": "#2563eb",
  "color_primary_fg": "#ffffff",
  "color_background": "#0f172a",
  "color_foreground": "#ffffff",
  "color_card": "#22222a",
  "color_border": "#3b3b3b",
  "color_accent": "#34eeff",
  "color_accent_fg": "#000000",
  "color_canvas": "#0f1419",
  "color_muted": "#22222a",
  "color_muted_fg": "#b8b8b8",
  "email_local_part": "signatures"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
workspace_id
string<uuid>
required

Body

application/json
​
signing_request_email_header
string
​
signing_request_email_body
string
​
team_email
string<email>
​
timezone
string
​
language
enum<string>

Workspace language for email templates

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
​
show_credit_cost_in_editor
boolean

Whether to display credit cost in embedded editors

​
require_otp_verification
boolean | null

Whether signers must verify their email via OTP. null = inherit from company

​
require_terms_acceptance
boolean | null

Whether signers must accept terms before signing. null inherits the company-level setting.

​
disable_guided_navigation
boolean | null

Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set.

​
show_signature_frame
boolean | null

Whether to render signature frames in completed PDFs. null = inherit from company

​
color_primary
string | null

Primary color override (#rrggbb hex). Null to inherit from company.

​
color_primary_fg
string | null

Primary foreground color override. Null to inherit from company.

​
color_background
string | null

Background color override. Null to inherit from company.

​
color_foreground
string | null

Foreground/text color override. Null to inherit from company.

​
color_card
string | null

Card background color override. Null to inherit from company.

​
color_border
string | null

Border color override. Null to inherit from company.

​
color_accent
string | null

Editor chrome accent color. Null to inherit from company.

​
color_accent_fg
string | null

Foreground color on accent surfaces. Null to inherit from company.

​
color_canvas
string | null

Editor document-canvas surround color. Null to inherit from company.

​
color_muted
string | null

Muted surface color. Null to inherit from company.

​
color_muted_fg
string | null

Muted text color. Null to inherit from company.

​
email_local_part
string | null

The local-part (before the @) of the sender email address. Null to inherit from company setting.

Required string length: 1 - 64
Pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$

Response

Workspace settings updated successfully

​
workspace_id
string<uuid>
​
name
string

Workspace name

​
team_email
string<email>

Workspace contact email

​
timezone
string

Workspace timezone

​
language
enum<string>
default:en

Workspace language for email templates

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
​
signing_request_email_header
string

Custom email header text

​
signing_request_email_body
string

Custom HTML email body

​
show_credit_cost_in_editor
boolean
default:true

Whether to display credit cost in embedded template and signing request editors

​
require_otp_verification
boolean | null

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 | null

Whether signers must accept terms before signing. null inherits the company-level setting.

​
disable_guided_navigation
boolean | null

Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set.

​
show_signature_frame
boolean | null

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

​
color_primary
string | null

Primary color override (#rrggbb hex). Null to inherit from company.

Example:

"#2563eb"

​
color_primary_fg
string | null

Primary foreground color override. Null to inherit.

Example:

"#ffffff"

​
color_background
string | null

Background color override. Null to inherit.

Example:

"#0f172a"

​
color_foreground
string | null

Foreground/text color override. Null to inherit.

Example:

"#ffffff"

​
color_card
string | null

Card background color override. Null to inherit.

Example:

"#22222a"

​
color_border
string | null

Border color override. Null to inherit.

Example:

"#3b3b3b"

​
color_accent
string | null

Editor chrome accent color. Null to inherit.

Example:

"#34eeff"

​
color_accent_fg
string | null

Foreground color on accent surfaces. Null to inherit.

Example:

"#000000"

​
color_canvas
string | null

Editor document-canvas surround color. Null to inherit.

Example:

"#0f1419"

​
color_muted
string | null

Muted surface color. Null to inherit.

Example:

"#22222a"

​
color_muted_fg
string | null

Muted text color. Null to inherit.

Example:

"#b8b8b8"

​
email_local_part
string | null

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.

Required string length: 1 - 64
Pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
Example:

"signatures"