Skip to main content
PUT
/
workspace
/
{workspace_id}
/
settings
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.workspaceSettings.updateWorkspaceSettings({
    workspace_id: "workspace_id"
});
console.log(response);
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>",
  "allow_presigning_download": true,
  "show_partial_watermark": true,
  "show_qr_code": true,
  "signing_button_label_overrides": {}
}
'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings"

payload = {
    "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>",
    "allow_presigning_download": True,
    "show_partial_watermark": True,
    "show_qr_code": True,
    "signing_button_label_overrides": {}
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
    allow_presigning_download: true,
    show_partial_watermark: true,
    show_qr_code: true,
    signing_button_label_overrides: {}
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
    'allow_presigning_download' => true,
    'show_partial_watermark' => true,
    'show_qr_code' => true,
    'signing_button_label_overrides' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings"

	payload := strings.NewReader("{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"signing_request_email_header\": \"<string>\",\n  \"signing_request_email_body\": \"<string>\",\n  \"team_email\": \"jsmith@example.com\",\n  \"timezone\": \"<string>\",\n  \"show_credit_cost_in_editor\": true,\n  \"require_otp_verification\": true,\n  \"require_terms_acceptance\": true,\n  \"disable_guided_navigation\": true,\n  \"show_signature_frame\": true,\n  \"color_primary\": \"<string>\",\n  \"color_primary_fg\": \"<string>\",\n  \"color_background\": \"<string>\",\n  \"color_foreground\": \"<string>\",\n  \"color_card\": \"<string>\",\n  \"color_border\": \"<string>\",\n  \"color_accent\": \"<string>\",\n  \"color_accent_fg\": \"<string>\",\n  \"color_canvas\": \"<string>\",\n  \"color_muted\": \"<string>\",\n  \"color_muted_fg\": \"<string>\",\n  \"email_local_part\": \"<string>\",\n  \"allow_presigning_download\": true,\n  \"show_partial_watermark\": true,\n  \"show_qr_code\": true,\n  \"signing_button_label_overrides\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "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,
  "allow_presigning_download": true,
  "show_partial_watermark": true,
  "show_qr_code": 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",
  "signing_button_label_overrides": {}
}
{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}
{
  "error": "Unauthorized",
  "message": "Invalid API key"
}
{
  "error": "Not Found",
  "message": "The requested resource was not found"
}
{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

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])?$
​
allow_presigning_download
boolean | null

Allow signers to download the original document before signing. Inherits from workspace or company setting when null.

​
show_partial_watermark
boolean | null

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

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

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.

Response

Workspace settings updated successfully

​
workspace_id
string<uuid>
required
​
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

​
allow_presigning_download
boolean | null

Allow signers to download the original document before signing. null inherits the company-level setting.

​
show_partial_watermark
boolean | null

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

Show a QR code on the signing page that lets signers continue on their phone. null inherits the company-level setting.

​
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"

​
signing_button_label_overrides
object | null

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.