@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.templates.updateTemplate({
    id: "id"
});
console.log(response);

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=",
    "document_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_hours": 2,
    "settings": {
      "allow_editing_before_sending": true,
      "attach_pdf_on_finish": true,
      "allow_download": true,
      "hand_drawn_only": true,
      "require_otp_verification": true,
      "disable_guided_navigation": true,
      "allow_presigning_download": true,
      "show_qr_code": true
    }
  },
  "users": [
    {
      "first_name": "<string>",
      "email": "jsmith@example.com",
      "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>"
    }
  ],
  "force_remove_conditions": false,
  "deleted_users": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reassign_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "fields": [
    {
      "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>",
      "variable_defined_name": "<string>",
      "required_conditions": {
        "groups": [
          {
            "conditions": [
              {
                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ]
          }
        ]
      },
      "visibility_conditions": {
        "groups": [
          {
            "conditions": [
              {
                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ]
          }
        ]
      }
    }
  ],
  "reminders": [
    {
      "hours": 2,
      "subject": "<string>",
      "message": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "all_users": false,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "documents_layout_version": 1,
  "seal_participants": [
    {
      "seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "temp_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}"

payload = {
    "template_properties": {
        "name": "<string>",
        "description": "<string>",
        "document": "aSDinaTvuI8gbWludGxpZnk=",
        "document_id": "123e4567-e89b-12d3-a456-426614174000",
        "expiration_hours": 2,
        "settings": {
            "allow_editing_before_sending": True,
            "attach_pdf_on_finish": True,
            "allow_download": True,
            "hand_drawn_only": True,
            "require_otp_verification": True,
            "disable_guided_navigation": True,
            "allow_presigning_download": True,
            "show_qr_code": True
        }
    },
    "users": [
        {
            "first_name": "<string>",
            "email": "jsmith@example.com",
            "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>"
        }
    ],
    "force_remove_conditions": False,
    "deleted_users": [
        {
            "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reassign_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "fields": [
        {
            "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>",
            "variable_defined_name": "<string>",
            "required_conditions": { "groups": [{ "conditions": [
                            {
                                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                                "value": "<string>"
                            }
                        ] }] },
            "visibility_conditions": { "groups": [{ "conditions": [
                            {
                                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                                "value": "<string>"
                            }
                        ] }] }
        }
    ],
    "reminders": [
        {
            "hours": 2,
            "subject": "<string>",
            "message": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "all_users": False,
            "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "documents_layout_version": 1,
    "seal_participants": [
        {
            "seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order": 2,
            "temp_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    template_properties: {
      name: '<string>',
      description: '<string>',
      document: 'aSDinaTvuI8gbWludGxpZnk=',
      document_id: '123e4567-e89b-12d3-a456-426614174000',
      expiration_hours: 2,
      settings: {
        allow_editing_before_sending: true,
        attach_pdf_on_finish: true,
        allow_download: true,
        hand_drawn_only: true,
        require_otp_verification: true,
        disable_guided_navigation: true,
        allow_presigning_download: true,
        show_qr_code: true
      }
    },
    users: [
      {
        first_name: '<string>',
        email: 'jsmith@example.com',
        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>'
      }
    ],
    force_remove_conditions: false,
    deleted_users: [
      {
        user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        reassign_to_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    fields: [
      {
        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>',
        variable_defined_name: '<string>',
        required_conditions: {
          groups: [
            {
              conditions: [{field_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
            }
          ]
        },
        visibility_conditions: {
          groups: [
            {
              conditions: [{field_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
            }
          ]
        }
      }
    ],
    reminders: [
      {
        hours: 2,
        subject: '<string>',
        message: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        all_users: false,
        user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    documents_layout_version: 1,
    seal_participants: [
      {seal_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', order: 2, temp_id: '<string>'}
    ]
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'template_properties' => [
        'name' => '<string>',
        'description' => '<string>',
        'document' => 'aSDinaTvuI8gbWludGxpZnk=',
        'document_id' => '123e4567-e89b-12d3-a456-426614174000',
        'expiration_hours' => 2,
        'settings' => [
                'allow_editing_before_sending' => true,
                'attach_pdf_on_finish' => true,
                'allow_download' => true,
                'hand_drawn_only' => true,
                'require_otp_verification' => true,
                'disable_guided_navigation' => true,
                'allow_presigning_download' => true,
                'show_qr_code' => true
        ]
    ],
    'users' => [
        [
                'first_name' => '<string>',
                'email' => 'jsmith@example.com',
                '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>'
        ]
    ],
    'force_remove_conditions' => false,
    'deleted_users' => [
        [
                'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'reassign_to_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'fields' => [
        [
                '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>',
                'variable_defined_name' => '<string>',
                'required_conditions' => [
                                'groups' => [
                                                                [
                                                                                                                                'conditions' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'field_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'value' => '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'visibility_conditions' => [
                                'groups' => [
                                                                [
                                                                                                                                'conditions' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'field_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'value' => '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ],
    'reminders' => [
        [
                'hours' => 2,
                'subject' => '<string>',
                'message' => '<string>',
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'all_users' => false,
                'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'documents_layout_version' => 1,
    'seal_participants' => [
        [
                'seal_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'order' => 2,
                'temp_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}"

	payload := strings.NewReader("{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_date": "2023-11-07T05:31:56Z",
  "seal_participants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "seal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "version": 123,
        "display_name": "<string>"
      },
      "status": "pending",
      "applied_at": "2023-11-07T05:31:56Z",
      "paused_at": "2023-11-07T05:31:56Z",
      "pause_reason": "seal_revoked_stop_pending",
      "swapped_from_seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "triggered_by_recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sender_kind": "dashboard",
      "seal_out_of_scope": true
    }
  ],
  "description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "page_count": 2,
  "expiration_hours": 168,
  "credit_cost": 1,
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "use_signing_order": true,
    "hand_drawn_only": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true,
    "require_otp_verification": null,
    "disable_guided_navigation": true,
    "allow_presigning_download": true,
    "show_qr_code": true,
    "identity_editable_fields": [
      "<string>"
    ],
    "notify_identity_change_email": false
  },
  "recipients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "designation": "Signer",
      "order": 2,
      "name": "<string>",
      "last_name": "<string>",
      "phone_number": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state_province": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "title": "<string>",
      "company": "<string>",
      "required_fields": [
        "<string>"
      ],
      "missing_fields": [
        "<string>"
      ],
      "required_read_only_fields": [
        {
          "variable_name": "<string>",
          "variable_defined_name": "<string>",
          "field_type": "<string>"
        }
      ],
      "ready_to_send": true
    }
  ],
  "fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "text",
      "page_number": 2,
      "required": true,
      "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variable_name": "<string>",
      "variable_defined_name": "<string>",
      "position": {
        "x": 50,
        "y": 50,
        "width": 50,
        "height": 50
      },
      "dropdown_options": [
        "<string>"
      ],
      "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date_default": "2023-12-25",
      "date_signing_default": true,
      "format_rules": {
        "dateFormat": "MMMM dd, yyyy"
      },
      "validation_rules": {},
      "read_only": false,
      "read_only_value": "<string>"
    }
  ],
  "updated_date": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "document_id": null,
      "position": 1,
      "label": null,
      "original_filename": null,
      "page_count": 3,
      "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
      "document_url_kind": "stored",
      "document_only_hash": null
    }
  ],
  "documents_version": 123,
  "documents_layout_version": 123
}

{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

Plantillas

Actualización Integral de Plantilla

Actualización integral de la plantilla, incluyendo propiedades, usuarios, campos y recordatorios. Admite la eliminación de usuarios con reasignación o eliminación de campos. Todas las secciones son opcionales, pero se debe proporcionar al menos una.

No atómico. Las partes de esta llamada no se aplican como una sola actualización. Cada entrada de users o deleted_users que añade, mueve o elimina a un firmante o a un aprobador se guarda por separado, en el orden de la petición. Si se rechaza uno de estos guardados, la llamada responde de inmediato con ese error: lo guardado antes se mantiene aplicado y el resto de la petición no se procesa. Los demás problemas (por ejemplo un usuario que no se encuentra, o un campo o un recordatorio no válido) se acumulan y se responden como un único 400 VALIDATION_ERROR al final de la llamada. Una vez acumulado un problema, algunos de los cambios restantes se omiten (las entradas de users, fields y reminders que le siguen) y otros todavía pueden aplicarse antes del 400, y lo guardado antes del problema se mantiene aplicado. El 400 no siempre indica qué entradas fallaron. Lee de nuevo la plantilla tras cualquier respuesta que no sea 2xx. Si la lectura de los participantes de sello de la plantilla para la respuesta falla después de las escrituras, la llamada responde 500 aunque las escrituras se hayan aplicado.

Participantes de sello. La propiedad de petición seal_participants define los participantes de sello de la plantilla. Cuando la clave está ausente, los participantes de sello de la plantilla no se modifican. Cuando es un array, el array reemplaza todo el conjunto: se elimina cada participante de sello que tenía la plantilla junto con los campos que poseía, y se crea un participante de sello por cada entrada, de modo que [] los elimina todos. Cada entrada es un objeto con seal_id (obligatorio, el ID de un sello de organización), order (obligatorio, un entero positivo que ninguna otra entrada repite y que no es mayor que el número de destinatarios de la plantilla más el número de entradas) y un temp_id opcional. Los destinatarios conservan su orden relativo y cada sello se coloca en su order. null, cualquier otro valor que no sea un array y una entrada sin seal_id responden 400 VALIDATION_ERROR; un order que incumple las reglas anteriores responde 400 INVALID_SIGNING_ORDER; un seal_id que no es un UUID responde 404 NOT_FOUND; un sello de tu empresa que está revocado o borrado responde 400 SEAL_UNAVAILABLE. Cada una de estas respuestas es inmediata y deja sin cambios los participantes de sello. seal_participants se procesa después de las demás partes de la llamada, también cuando estas acumularon problemas, por lo que puede aplicarse en una llamada que después responde 400 VALIDATION_ERROR.

PUT

templates

{id}

@firma-dev/sdk

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.templates.updateTemplate({
    id: "id"
});
console.log(response);

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=",
    "document_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_hours": 2,
    "settings": {
      "allow_editing_before_sending": true,
      "attach_pdf_on_finish": true,
      "allow_download": true,
      "hand_drawn_only": true,
      "require_otp_verification": true,
      "disable_guided_navigation": true,
      "allow_presigning_download": true,
      "show_qr_code": true
    }
  },
  "users": [
    {
      "first_name": "<string>",
      "email": "jsmith@example.com",
      "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>"
    }
  ],
  "force_remove_conditions": false,
  "deleted_users": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reassign_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "fields": [
    {
      "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>",
      "variable_defined_name": "<string>",
      "required_conditions": {
        "groups": [
          {
            "conditions": [
              {
                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ]
          }
        ]
      },
      "visibility_conditions": {
        "groups": [
          {
            "conditions": [
              {
                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ]
          }
        ]
      }
    }
  ],
  "reminders": [
    {
      "hours": 2,
      "subject": "<string>",
      "message": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "all_users": false,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "documents_layout_version": 1,
  "seal_participants": [
    {
      "seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "temp_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}"

payload = {
    "template_properties": {
        "name": "<string>",
        "description": "<string>",
        "document": "aSDinaTvuI8gbWludGxpZnk=",
        "document_id": "123e4567-e89b-12d3-a456-426614174000",
        "expiration_hours": 2,
        "settings": {
            "allow_editing_before_sending": True,
            "attach_pdf_on_finish": True,
            "allow_download": True,
            "hand_drawn_only": True,
            "require_otp_verification": True,
            "disable_guided_navigation": True,
            "allow_presigning_download": True,
            "show_qr_code": True
        }
    },
    "users": [
        {
            "first_name": "<string>",
            "email": "jsmith@example.com",
            "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>"
        }
    ],
    "force_remove_conditions": False,
    "deleted_users": [
        {
            "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reassign_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "fields": [
        {
            "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>",
            "variable_defined_name": "<string>",
            "required_conditions": { "groups": [{ "conditions": [
                            {
                                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                                "value": "<string>"
                            }
                        ] }] },
            "visibility_conditions": { "groups": [{ "conditions": [
                            {
                                "field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                                "value": "<string>"
                            }
                        ] }] }
        }
    ],
    "reminders": [
        {
            "hours": 2,
            "subject": "<string>",
            "message": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "all_users": False,
            "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "documents_layout_version": 1,
    "seal_participants": [
        {
            "seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order": 2,
            "temp_id": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    template_properties: {
      name: '<string>',
      description: '<string>',
      document: 'aSDinaTvuI8gbWludGxpZnk=',
      document_id: '123e4567-e89b-12d3-a456-426614174000',
      expiration_hours: 2,
      settings: {
        allow_editing_before_sending: true,
        attach_pdf_on_finish: true,
        allow_download: true,
        hand_drawn_only: true,
        require_otp_verification: true,
        disable_guided_navigation: true,
        allow_presigning_download: true,
        show_qr_code: true
      }
    },
    users: [
      {
        first_name: '<string>',
        email: 'jsmith@example.com',
        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>'
      }
    ],
    force_remove_conditions: false,
    deleted_users: [
      {
        user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        reassign_to_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    fields: [
      {
        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>',
        variable_defined_name: '<string>',
        required_conditions: {
          groups: [
            {
              conditions: [{field_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
            }
          ]
        },
        visibility_conditions: {
          groups: [
            {
              conditions: [{field_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
            }
          ]
        }
      }
    ],
    reminders: [
      {
        hours: 2,
        subject: '<string>',
        message: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        all_users: false,
        user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    documents_layout_version: 1,
    seal_participants: [
      {seal_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', order: 2, temp_id: '<string>'}
    ]
  })
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'template_properties' => [
        'name' => '<string>',
        'description' => '<string>',
        'document' => 'aSDinaTvuI8gbWludGxpZnk=',
        'document_id' => '123e4567-e89b-12d3-a456-426614174000',
        'expiration_hours' => 2,
        'settings' => [
                'allow_editing_before_sending' => true,
                'attach_pdf_on_finish' => true,
                'allow_download' => true,
                'hand_drawn_only' => true,
                'require_otp_verification' => true,
                'disable_guided_navigation' => true,
                'allow_presigning_download' => true,
                'show_qr_code' => true
        ]
    ],
    'users' => [
        [
                'first_name' => '<string>',
                'email' => 'jsmith@example.com',
                '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>'
        ]
    ],
    'force_remove_conditions' => false,
    'deleted_users' => [
        [
                'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'reassign_to_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'fields' => [
        [
                '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>',
                'variable_defined_name' => '<string>',
                'required_conditions' => [
                                'groups' => [
                                                                [
                                                                                                                                'conditions' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'field_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'value' => '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'visibility_conditions' => [
                                'groups' => [
                                                                [
                                                                                                                                'conditions' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'field_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'value' => '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ]
    ],
    'reminders' => [
        [
                'hours' => 2,
                'subject' => '<string>',
                'message' => '<string>',
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'all_users' => false,
                'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'documents_layout_version' => 1,
    'seal_participants' => [
        [
                'seal_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'order' => 2,
                'temp_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}"

	payload := strings.NewReader("{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"template_properties\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\",\n    \"document\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"document_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n    \"expiration_hours\": 2,\n    \"settings\": {\n      \"allow_editing_before_sending\": true,\n      \"attach_pdf_on_finish\": true,\n      \"allow_download\": true,\n      \"hand_drawn_only\": true,\n      \"require_otp_verification\": true,\n      \"disable_guided_navigation\": true,\n      \"allow_presigning_download\": true,\n      \"show_qr_code\": true\n    }\n  },\n  \"users\": [\n    {\n      \"first_name\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"order\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"last_name\": \"<string>\",\n      \"phone_number\": \"<string>\",\n      \"street_address\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state_province\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"title\": \"<string>\",\n      \"company\": \"<string>\"\n    }\n  ],\n  \"force_remove_conditions\": false,\n  \"deleted_users\": [\n    {\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reassign_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"x\": 50,\n      \"y\": 50,\n      \"width\": 50,\n      \"height\": 50,\n      \"page\": 2,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"required\": false,\n      \"assigned_to_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"options\": [\n        \"<string>\"\n      ],\n      \"default_to_signing_date\": true,\n      \"multi_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variable_name\": \"<string>\",\n      \"variable_defined_name\": \"<string>\",\n      \"required_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      },\n      \"visibility_conditions\": {\n        \"groups\": [\n          {\n            \"conditions\": [\n              {\n                \"field_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n                \"value\": \"<string>\"\n              }\n            ]\n          }\n        ]\n      }\n    }\n  ],\n  \"reminders\": [\n    {\n      \"hours\": 2,\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"all_users\": false,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"documents_layout_version\": 1,\n  \"seal_participants\": [\n    {\n      \"seal_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": 2,\n      \"temp_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_date": "2023-11-07T05:31:56Z",
  "seal_participants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 2,
      "seal": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lineage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "version": 123,
        "display_name": "<string>"
      },
      "status": "pending",
      "applied_at": "2023-11-07T05:31:56Z",
      "paused_at": "2023-11-07T05:31:56Z",
      "pause_reason": "seal_revoked_stop_pending",
      "swapped_from_seal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "triggered_by_recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sender_kind": "dashboard",
      "seal_out_of_scope": true
    }
  ],
  "description": "<string>",
  "document_url": "<string>",
  "document_url_expires_at": "2023-11-07T05:31:56Z",
  "page_count": 2,
  "expiration_hours": 168,
  "credit_cost": 1,
  "settings": {
    "allow_download": true,
    "attach_pdf_on_finish": true,
    "allow_editing_before_sending": false,
    "use_signing_order": true,
    "hand_drawn_only": false,
    "send_signing_email": true,
    "send_finish_email": true,
    "send_expiration_email": true,
    "send_cancellation_email": true,
    "require_otp_verification": null,
    "disable_guided_navigation": true,
    "allow_presigning_download": true,
    "show_qr_code": true,
    "identity_editable_fields": [
      "<string>"
    ],
    "notify_identity_change_email": false
  },
  "recipients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "designation": "Signer",
      "order": 2,
      "name": "<string>",
      "last_name": "<string>",
      "phone_number": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state_province": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "title": "<string>",
      "company": "<string>",
      "required_fields": [
        "<string>"
      ],
      "missing_fields": [
        "<string>"
      ],
      "required_read_only_fields": [
        {
          "variable_name": "<string>",
          "variable_defined_name": "<string>",
          "field_type": "<string>"
        }
      ],
      "ready_to_send": true
    }
  ],
  "fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "text",
      "page_number": 2,
      "required": true,
      "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variable_name": "<string>",
      "variable_defined_name": "<string>",
      "position": {
        "x": 50,
        "y": 50,
        "width": 50,
        "height": 50
      },
      "dropdown_options": [
        "<string>"
      ],
      "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date_default": "2023-12-25",
      "date_signing_default": true,
      "format_rules": {
        "dateFormat": "MMMM dd, yyyy"
      },
      "validation_rules": {},
      "read_only": false,
      "read_only_value": "<string>"
    }
  ],
  "updated_date": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "document_id": null,
      "position": 1,
      "label": null,
      "original_filename": null,
      "page_count": 3,
      "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
      "document_url_kind": "stored",
      "document_only_hash": null
    }
  ],
  "documents_version": 123,
  "documents_layout_version": 123
}

{
  "error": "Validation Error",
  "message": "Invalid input data",
  "details": {
    "name": "Name is required",
    "email": "Invalid email format"
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Not Found",
  "message": "The requested resource was not found"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

Autorizaciones

Authorization

string

header

requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

string<uuid>

requerido

Cuerpo

application/json

template_properties

object

Actualizar los metadatos y la configuración de la plantilla

Show child attributes

users

object[]

Insertar o actualizar usuarios (incluye id para actualizar, omítelo para crear). Un destinatario existente no puede cambiarse entre CC y Firmante/Aprobador (400); elimínalo y créalo de nuevo.

Show child attributes

force_remove_conditions

boolean

predeterminado:false

Al eliminar usuarios cuyos campos son referenciados por condiciones en otros campos: si es true, elimina automáticamente las referencias de condición; si es false (predeterminado), la solicitud será rechazada con un error.

deleted_users

object[]

Usuarios a eliminar con estrategia de manejo de campos

Show child attributes

fields

object[]

Crea o actualiza campos (incluye id para actualizar, omítelo para crear)

Show child attributes

reminders

object[]

Crea o actualiza recordatorios (incluye id para actualizar, omítelo para crear)

Show child attributes

documents_layout_version

integer

El documents_layout_version de su última lectura (multidocumento). Obligatorio para escribir un campo en una plantilla con más de un documento o con una versión de disposición superior a 1 (409 DOCUMENTS_LAYOUT_VERSION_REQUIRED); un valor obsoleto responde 409 DOCUMENT_SET_VERSION_CONFLICT; un valor que no es un entero no negativo responde 400 VALIDATION_ERROR con la clave documents_layout_version.

Rango requerido: x >= 0

seal_participants

object[]

Cuando está presente, el array reemplaza todo el conjunto de participantes de sello de la plantilla y elimina los campos que poseían los anteriores; [] los elimina todos; omite la clave para dejarlos sin cambios. null no se acepta: responde 400 VALIDATION_ERROR. Consulta la descripción de la operación para las reglas de cada entrada y los errores.

Show child attributes

Respuesta

Plantilla actualizada correctamente. Devuelve la plantilla completa con todas sus relaciones. seal_participants lista solo los participantes de sello cuyo sello pertenece a la empresa de la clave API: un participante de sello cuyo sello falta o pertenece a otra empresa se omite, de modo que una lista vacía o más corta no demuestra que la plantilla no tenga otro participante de sello guardado.

Una plantilla con sus participantes de sello: todas las claves de Template, más seal_participants. seal_participants lista solo los participantes de sello cuyo sello pertenece a la empresa de la clave API: un participante de sello cuyo sello falta o pertenece a otra empresa se omite, de modo que una lista vacía o más corta no demuestra que la plantilla no tenga otro participante de sello guardado.

string<uuid>

requerido

Identificador único de la plantilla

name

string

requerido

Nombre de la plantilla

Maximum string length: 255

created_date

string<date-time>

requerido

Marca de tiempo de creación de la plantilla

seal_participants

object[]

requerido

Los participantes de sello de la plantilla en orden, limitados a aquellos cuyo sello pertenece a la empresa de la clave API. Un participante de sello cuyo sello falta o pertenece a otra empresa se omite, de modo que una lista vacía o más corta no demuestra que la plantilla no tenga otro participante de sello guardado.

Show child attributes

description

string | null

Descripción de la plantilla

document_url

string<uri>

URL prefirmada al documento PDF. Es una URL firmada con tiempo limitado para acceso seguro; consulta document_url_expires_at para conocer el momento de expiración. Las URLs iniciales son válidas por 7 días; las URLs renovadas son válidas por 1 hora. Solicita una nueva recuperación de la plantilla para obtener una URL nueva si ha expirado.

document_url_expires_at

string<date-time> | null

Marca de tiempo ISO 8601 de cuándo expirará document_url. Después de este momento, la URL devolverá un error de acceso denegado. Vuelve a obtener la plantilla para recibir una nueva URL firmada.

page_count

integer

Número de páginas del documento

Rango requerido: x >= 1

expiration_hours

integer

predeterminado:168

Horas hasta que expiren las solicitudes de firma creadas a partir de esta plantilla

Rango requerido: x >= 1

credit_cost

integer

predeterminado:1

Número de créditos consumidos cuando se envía una solicitud de firma desde esta plantilla. El valor mínimo es 1.

Rango requerido: x >= 1

settings

object

Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).

Show child attributes

recipients

object[]

Destinatarios de la plantilla (incluido en GET de una sola plantilla)

Show child attributes

fields

object[]

Campos de la plantilla (incluido en GET de una sola plantilla)

Show child attributes

updated_date

string<date-time>

Marca de tiempo de la última actualización de la plantilla

documents

object[]

Los documentos de la plantilla en orden de posición (multidocumento; presente solo para las empresas habilitadas). En GET /templates (el listado): una entrada de listado no incluye document_url. Un elemento cuyo conjunto de documentos nunca se ha modificado aparece aquí con documents: [], mientras que su GET individual devuelve su único documento (con document_id null). En GET /templates/{id}, PUT /templates/{id} y POST /templates: un elemento cuyo conjunto de documentos nunca se ha modificado devuelve su único documento, con document_id null.

Show child attributes

documents_version

integer

Versión del conjunto de documentos; aumenta con cada cambio de documentos (multidocumento; solo empresas habilitadas).

documents_layout_version

integer

Versión de la disposición de los documentos; aumenta cuando se añaden, eliminan o reordenan documentos (multidocumento; solo empresas habilitadas). Las escrituras de campos en una solicitud de firma con más de un documento la devuelven como documents_layout_version.