Skip to main content
PUT
/
templates
/
{id}
Comprehensive Template Update
curl --request PUT \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_properties": {
    "name": "<string>",
    "description": "<string>",
    "document": "aSDinaTvuI8gbWludGxpZnk=",
    "expiration_hours": 2,
    "settings": {
      "allow_editing_before_sending": true,
      "attach_pdf_on_finish": true,
      "allow_download": true
    }
  },
  "users": [
    {
      "first_name": "<string>",
      "email": "jsmith@example.com",
      "designation": "Signer",
      "order": 2,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "phone_number": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state_province": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "title": "<string>",
      "company": "<string>"
    }
  ],
  "deleted_users": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "field_action": "delete",
      "reassign_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "fields": [
    {
      "type": "signature",
      "x": 50,
      "y": 50,
      "width": 50,
      "height": 50,
      "page": 2,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "required": false,
      "assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "options": [
        "<string>"
      ],
      "default_to_signing_date": true,
      "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variable_name": "<string>"
    }
  ],
  "reminders": [
    {
      "hours": 2,
      "subject": "<string>",
      "message": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "all_users": false,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "credit_cost": 1,
  "date_created": "2023-11-07T05:31:56Z",
  "date_changed": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.firma.dev/llms.txt

Use this file to discover all available pages before exploring further.

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
​
template_properties
object

Update template metadata and settings

​
users
object[]

Upsert users (include id to update, omit to create)

​
deleted_users
object[]

Users to delete with field handling strategy

​
fields
object[]

Upsert fields (include id to update, omit to create)

​
reminders
object[]

Upsert reminders (include id to update, omit to create)

Response

Template updated successfully. Returns full template with all relationships.

​
id
string<uuid>

Unique identifier for the template

​
name
string

Template name

Maximum string length: 255
​
description
string | null

Template description

​
document_url
string<uri>

Pre-signed URL to the PDF document. This is a time-limited signed URL for secure access - see document_url_expires_at for expiration time. Initial URLs are valid for 7 days; refreshed URLs are valid for 1 hour. Request a new template retrieval to get a fresh URL if expired.

​
document_url_expires_at
string<date-time> | null

ISO 8601 timestamp when the document_url will expire. After this time, the URL will return an access denied error. Fetch the template again to receive a fresh signed URL.

​
credit_cost
integer
default:1

Number of credits consumed when a signing request is sent from this template. Minimum value is 1.

Required range: x >= 1
​
date_created
string<date-time>

Template creation timestamp

​
date_changed
string<date-time>

Template last update timestamp