@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
  }
}

Modèles

Mise à Jour Complète du Modèle

Mise à jour complète du modèle incluant les propriétés, les utilisateurs, les champs et les rappels. Prend en charge la suppression d’utilisateurs avec réassignation ou suppression des champs. Toutes les sections sont optionnelles mais au moins une doit être fournie.

Non atomique. Les parties de cet appel ne sont pas appliquées comme une seule mise à jour. Chaque entrée de users ou de deleted_users qui ajoute, déplace ou supprime un signataire ou un approbateur est enregistrée séparément, dans l’ordre de la requête. Si l’un de ces enregistrements est refusé, l’appel répond immédiatement avec cette erreur : ce qui a été enregistré avant reste appliqué et le reste de la requête n’est pas traité. Les autres problèmes (par exemple un utilisateur introuvable, ou un champ ou un rappel invalide) sont collectés et renvoyés sous la forme d’un seul 400 VALIDATION_ERROR à la fin de l’appel. Une fois un problème collecté, certaines des modifications restantes sont ignorées (les entrées users, fields et reminders qui le suivent) et d’autres peuvent encore être appliquées avant le 400, et ce qui a été enregistré avant le problème reste appliqué. Le 400 n’indique pas toujours quelles entrées ont échoué. Relisez le modèle après toute réponse non 2xx. Si la lecture des participants de cachet du modèle pour la réponse échoue après les écritures, l’appel répond 500 bien que les écritures aient été appliquées.

Participants de cachet. La propriété de requête seal_participants définit les participants de cachet du modèle. Lorsque la clé est absente, les participants de cachet du modèle restent inchangés. Lorsque c’est un tableau, le tableau remplace l’ensemble : chaque participant de cachet que le modèle possédait est supprimé avec les champs qu’il détenait, et un participant de cachet est créé pour chaque entrée, de sorte que [] les supprime tous. Chaque entrée est un objet avec seal_id (obligatoire, l’ID d’un cachet d’organisation), order (obligatoire, un entier positif qu’aucune autre entrée ne répète et qui n’est pas supérieur au nombre de destinataires du modèle plus le nombre d’entrées) et un temp_id facultatif. Les destinataires conservent leur ordre relatif et chaque cachet est placé à son order. null, toute autre valeur qui n’est pas un tableau et une entrée sans seal_id répondent 400 VALIDATION_ERROR ; un order qui enfreint les règles ci-dessus répond 400 INVALID_SIGNING_ORDER ; un seal_id qui n’est pas un UUID répond 404 NOT_FOUND ; un cachet de votre entreprise révoqué ou supprimé répond 400 SEAL_UNAVAILABLE. Chacune de ces réponses est immédiate et laisse les participants de cachet inchangés. seal_participants est traité après les autres parties de l’appel, même lorsqu’elles ont collecté des problèmes, il peut donc être appliqué dans un appel qui répond ensuite 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
  }
}

Autorisations

Authorization

string

header

requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

string<uuid>

requis

Corps

application/json

template_properties

object

Mettre à jour les métadonnées et les paramètres du modèle

Show child attributes

users

object[]

Crée ou met à jour des utilisateurs (inclure id pour mettre à jour, omettre pour créer). Un destinataire existant ne peut pas passer de CC à Signataire/Approbateur, ni inversement (400) ; supprimez-le et recréez-le.

Show child attributes

force_remove_conditions

boolean

défaut:false

Lors de la suppression d'utilisateurs dont les champs sont référencés par des conditions dans d'autres champs : si true, supprime automatiquement les références de condition ; si false (par défaut), la requête sera rejetée avec une erreur.

deleted_users

object[]

Utilisateurs à supprimer avec stratégie de gestion des champs

Show child attributes

fields

object[]

Upsert des champs (inclure id pour mettre à jour, omettre pour créer)

Show child attributes

reminders

object[]

Upsert des rappels (inclure id pour mettre à jour, omettre pour créer)

Show child attributes

documents_layout_version

integer

Le documents_layout_version de votre dernière lecture (multi-documents). Obligatoire pour écrire un champ sur un modèle comportant plus d'un document ou une version de mise en page supérieure à 1 (409 DOCUMENTS_LAYOUT_VERSION_REQUIRED) ; une valeur obsolète répond 409 DOCUMENT_SET_VERSION_CONFLICT ; une valeur qui n'est pas un entier positif ou nul répond 400 VALIDATION_ERROR avec la clé documents_layout_version.

Plage requise: x >= 0

seal_participants

object[]

Lorsqu'il est présent, le tableau remplace l'ensemble des participants de cachet du modèle et supprime les champs que détenaient les précédents ; [] les supprime tous ; omettez la clé pour les laisser inchangés. null n'est pas accepté : il répond 400 VALIDATION_ERROR. Consultez la description de l'opération pour les règles de chaque entrée et les erreurs.

Show child attributes

Réponse

Modèle mis à jour avec succès. Retourne le modèle complet avec toutes ses relations. seal_participants ne liste que les participants de cachet dont le cachet appartient à l'entreprise de la clé API : un participant de cachet dont le cachet est manquant ou appartient à une autre entreprise est omis, de sorte qu'une liste vide ou plus courte ne prouve pas que le modèle n'a pas d'autre participant de cachet enregistré.

Un modèle avec ses participants de cachet : toutes les clés de Template, plus seal_participants. seal_participants ne liste que les participants de cachet dont le cachet appartient à l'entreprise de la clé API : un participant de cachet dont le cachet est manquant ou appartient à une autre entreprise est omis, de sorte qu'une liste vide ou plus courte ne prouve pas que le modèle n'a pas d'autre participant de cachet enregistré.

string<uuid>

requis

Identifiant unique du modèle

name

string

requis

Nom du modèle

Maximum string length: 255

created_date

string<date-time>

requis

Timestamp de création du modèle

seal_participants

object[]

requis

Les participants de cachet du modèle dans l'ordre, limités à ceux dont le cachet appartient à l'entreprise de la clé API. Un participant de cachet dont le cachet est manquant ou appartient à une autre entreprise est omis, de sorte qu'une liste vide ou plus courte ne prouve pas que le modèle n'a pas d'autre participant de cachet enregistré.

Show child attributes

description

string | null

Description du modèle

document_url

string<uri>

URL pré-signée vers le document PDF. Il s'agit d'une URL signée à durée limitée pour un accès sécurisé, voir document_url_expires_at pour la date d'expiration. Les URL initiales sont valables 7 jours ; les URL rafraîchies sont valables 1 heure. Demandez une nouvelle récupération du modèle pour obtenir une URL fraîche si elle a expiré.

document_url_expires_at

string<date-time> | null

Timestamp ISO 8601 auquel document_url expirera. Après cette heure, l'URL retournera une erreur d'accès refusé. Récupérez à nouveau le modèle pour recevoir une nouvelle URL signée.

page_count

integer

Nombre de pages dans le document

Plage requise: x >= 1

expiration_hours

integer

défaut:168

Nombre d'heures avant l'expiration des demandes de signature créées à partir de ce modèle

Plage requise: x >= 1

credit_cost

integer

défaut:1

Nombre de crédits consommés lorsqu'une demande de signature est envoyée à partir de ce modèle. La valeur minimale est 1.

Plage requise: x >= 1

settings

object

Paramètres renvoyés par les endpoints de liste et de détail des demandes de signature. Les modèles utilisent le schéma TemplateSettings (sans champs d'identité).

Show child attributes

recipients

object[]

Destinataires du modèle (inclus dans la récupération d'un seul modèle)

Show child attributes

fields

object[]

Champs du modèle (inclus dans la récupération d'un seul modèle)

Show child attributes

updated_date

string<date-time>

Timestamp de dernière mise à jour du modèle

documents

object[]

Les documents du modèle dans l'ordre des positions (multi-documents ; présent uniquement pour les entreprises activées). Sur GET /templates (la liste) : une entrée de liste ne contient pas de document_url. Un élément dont l'ensemble de documents n'a jamais été modifié apparaît ici avec documents: [], tandis que son GET individuel renvoie son unique document (avec document_id null). Sur GET /templates/{id}, PUT /templates/{id} et POST /templates : un élément dont l'ensemble de documents n'a jamais été modifié renvoie son unique document, avec document_id null.

Show child attributes

documents_version

integer

Version de l'ensemble de documents, incrémentée à chaque modification de document (multi-documents ; entreprises activées uniquement).

documents_layout_version

integer

Version de la mise en page des documents, incrémentée lorsque des documents sont ajoutés, supprimés ou réordonnés (multi-documents ; entreprises activées uniquement). Les écritures de champs sur une demande de signature comportant plus d'un document la renvoient sous la forme documents_layout_version.