Passer au contenu principal
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=",
    "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"
    }
  ]
}
'
import requests

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

payload = {
    "template_properties": {
        "name": "<string>",
        "description": "<string>",
        "document": "aSDinaTvuI8gbWludGxpZnk=",
        "expiration_hours": 2,
        "settings": {
            "allow_editing_before_sending": True,
            "attach_pdf_on_finish": True,
            "allow_download": True,
            "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"
        }
    ]
}
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=',
      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'
      }
    ]
  })
};

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=',
        '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'
        ]
    ]
  ]),
  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    \"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}")

	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    \"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}")
  .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    \"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}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_date": "2023-11-07T05:31:56Z",
  "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>",
      "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",
      "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"
}
{
  "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": "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

​
id
string<uuid>
requis

Corps

application/json
​
template_properties
object

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

​
users
object[]

Crée ou met à jour des utilisateurs (inclure id pour mettre à jour, omettre pour créer)

​
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

​
fields
object[]

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

​
reminders
object[]

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

Réponse

Modèle mis à jour avec succès. Retourne le modèle complet avec toutes ses relations.

​
id
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

​
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é).

​
recipients
object[]

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

​
fields
object[]

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

​
updated_date
string<date-time>

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