Skip to main content
PATCH
/
signing-requests
/
{id}
curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Contract Name",
  "expiration_hours": 72
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "template_description": "<string>",
  "document_url": "<string>",
  "expiration_hours": 123
}

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

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