Skip to main content
PATCH
@firma-dev/sdk

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

id
string<uuid>
required

Signing request ID

Body

application/json

Update signing request properties only

name
string

New name for signing request

Maximum string length: 255
description
string

New description

document
string<byte>

Replace document with new base64-encoded PDF. Page count will be auto-extracted.

expiration_hours
integer

New expiration hours

Required range: x >= 1
settings
object

Update settings

language
enum<string> | null

Opt-in email language for this signing request. When set, all signer-facing emails (and their date formatting) use it. Omit or null to fall back to the workspace, then company, default language (unchanged behavior).

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl,
cs,
sv,
nl,
ro,
nb
completion_title
string | null

Heading shown on the completion page after signing. Null or an empty string clears the override; omitted leaves it unchanged.

Maximum string length: 200
completion_message
string | null

Body text shown on the completion page after signing. Null or an empty string clears the override; omitted leaves it unchanged.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

URL the signer is redirected to from the completion page. Must use https:// (http://localhost and http://127.0.0.1 are also accepted on test-mode signing requests). Null or an empty string clears the override; omitted leaves it unchanged.

Maximum string length: 2000
completion_redirect_delay
integer | null

Seconds the completion page waits before redirecting (0 redirects immediately). Only applies when a redirect URL resolves; the page falls back to 5 seconds when no level sets a delay. Null clears the override; omitted leaves it unchanged.

Required range: 0 <= x <= 30

Response

Signing request updated successfully. Response shape depends on what was updated: properties update returns {id, name, template_description, document_url, expiration_hours}; recipient update returns the full recipient object; field update returns the full field object. Response may include a 'warning' field for email format validation warnings (non-blocking).

Response when updating properties

id
string<uuid>
name
string
template_description
string | null
document_url
string<uri>
expiration_hours
integer