Skip to main content
PUT
/
company
/
settings
Update company settings
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/company/settings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_expiration_hours": 2,
  "require_terms_acceptance": true,
  "show_custom_branding_only": true,
  "require_otp_verification": true,
  "allow_presigning_download": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "show_partial_watermark": true,
  "email_local_part": "<string>",
  "color_primary": "<string>",
  "color_primary_fg": "<string>",
  "color_background": "<string>",
  "color_foreground": "<string>",
  "color_card": "<string>",
  "color_border": "<string>"
}
'
{
  "default_expiration_hours": 2,
  "require_terms_acceptance": true,
  "show_custom_branding_only": true,
  "require_otp_verification": true,
  "allow_presigning_download": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "show_partial_watermark": true,
  "email_local_part": "<string>",
  "color_primary": "<string>",
  "color_primary_fg": "<string>",
  "color_background": "<string>",
  "color_foreground": "<string>",
  "color_card": "<string>",
  "color_border": "<string>"
}

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.

Body

application/json
default_expiration_hours
integer

Default signing request expiration in hours

Required range: x >= 1
require_terms_acceptance
boolean

Whether signers must accept terms before signing

show_custom_branding_only
boolean
require_otp_verification
boolean
allow_presigning_download
boolean
disable_guided_navigation
boolean
show_signature_frame
boolean
show_partial_watermark
boolean
email_local_part
string
color_primary
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_primary_fg
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_background
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_foreground
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_card
string | null
Pattern: ^#[0-9A-Fa-f]{6}$
color_border
string | null
Pattern: ^#[0-9A-Fa-f]{6}$

Response

Company settings updated successfully

default_expiration_hours
integer
Required range: x >= 1
require_terms_acceptance
boolean
show_custom_branding_only
boolean
require_otp_verification
boolean
allow_presigning_download
boolean
disable_guided_navigation
boolean
show_signature_frame
boolean
show_partial_watermark
boolean
email_local_part
string
color_primary
string | null
color_primary_fg
string | null
color_background
string | null
color_foreground
string | null
color_card
string | null
color_border
string | null