Skip to main content
PATCH
/
templates
/
{id}
Partially Update Template
curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "document": "aSDinaTvuI8gbWludGxpZnk=",
  "expiration_hours": 2,
  "settings": {
    "allow_editing_before_sending": true,
    "attach_pdf_on_finish": true,
    "allow_download": true,
    "use_signing_order": true
  }
}'
{
  "message": "<string>",
  "updated_fields": [
    "<string>"
  ],
  "user": {}
}

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

Body

application/json
  • Option 1
  • Option 2

Update template properties

name
string

Template name

Maximum length: 255
description
string

Template description

document
string<byte>

Base64-encoded PDF to replace document. Maximum size: 20MB

expiration_hours
integer

Hours until expiration

Required range: x >= 1
settings
object

Response

Template partially updated successfully

message
string
updated_fields
string[]

Returned when updating properties

user
object

Returned when updating/creating a user

I