@firma-dev/sdk

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

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

const response = await firma.templates.patchTemplate({
    id: "id",
    body: {
        name: "Updated Template Name",
        expiration_hours: 72
    }
});
console.log(response);

curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Template Name",
  "expiration_hours": 72
}
'

import requests

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

payload = {
    "name": "Updated Template Name",
    "expiration_hours": 72
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Updated Template Name', expiration_hours: 72})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Template Name',
    'expiration_hours' => 72
  ]),
  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  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\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::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\n}"

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

{
  "message": "<string>",
  "updated_fields": [
    "<string>"
  ],
  "user": {}
}

Modèles

Mettre à Jour Partiellement un Modèle

Met à jour les propriétés du modèle, un seul utilisateur, OU un seul champ. Impossible de mélanger plusieurs types d’entités dans une seule requête. Utilisez PUT pour des mises à jour complètes incluant les utilisateurs, les champs et les rappels. Un seal_participant qui désigne un cachet répond 404 NOT_FOUND lorsque le cachet n’existe pas ou appartient à une autre entreprise, et 400 SEAL_UNAVAILABLE lorsque le cachet est révoqué, supprimé ou n’est pas la version courante de sa lignée. Ajouter un participant de cachet ou changer son cachet répond 503 SEALS_DISABLED lorsque les cachets d’organisation ne sont pas activés. Ajouter un participant de cachet exige order (voir le contrat d’ordre).

PATCH

templates

{id}

@firma-dev/sdk

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

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

const response = await firma.templates.patchTemplate({
    id: "id",
    body: {
        name: "Updated Template Name",
        expiration_hours: 72
    }
});
console.log(response);

curl --request PATCH \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Template Name",
  "expiration_hours": 72
}
'

import requests

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

payload = {
    "name": "Updated Template Name",
    "expiration_hours": 72
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Updated Template Name', expiration_hours: 72})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Template Name',
    'expiration_hours' => 72
  ]),
  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  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\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::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Template Name\",\n  \"expiration_hours\": 72\n}"

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

{
  "message": "<string>",
  "updated_fields": [
    "<string>"
  ],
  "user": {}
}

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

Option 1
Option 2
Option 3
Option 4

Mettre à jour les propriétés du modèle

name

string

Nom du modèle

Maximum string length: 255

description

string

Description du modèle

document

string<byte>

PDF ou DOCX encodé en base64 pour remplacer le document. Les fichiers DOCX sont automatiquement convertis en PDF. Pour les documents de plus de 5 Mo, utilisez POST /documents et transmettez le document_id à la place. (mutuellement exclusif avec document_id)

document_id

string<uuid>

ID d'un document précédemment téléversé (mutuellement exclusif avec document). À obtenir en appelant d'abord POST /documents.

Exemple:

"123e4567-e89b-12d3-a456-426614174000"

expiration_hours

integer

Heures avant expiration

Plage requise: x >= 1

settings

object

Show child attributes

Réponse

Modèle partiellement mis à jour avec succès. Mettre à jour un participant de cachet renvoie { "seal_participant": <SealParticipantApi> }.

Option 1
Option 2

Résultat de la mise à jour partielle du modèle

message

string

requis

updated_fields

string[]

requis

Retourné lors de la mise à jour des propriétés

user

object

Retourné lors de la mise à jour/création d'un utilisateur