@firma-dev/sdk

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

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

const response = await firma.templates.duplicateTemplate({
    id: "id",
    name: "Q4 2025 Contract"
});
console.log(response);

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q4 2025 Contract"
}
'

import requests

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

payload = { "name": "Q4 2025 Contract" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Q4 2025 Contract'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate', 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}/duplicate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q4 2025 Contract'
  ]),
  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}/duplicate"

	payload := strings.NewReader("{\n  \"name\": \"Q4 2025 Contract\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q4 2025 Contract\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q4 2025 Contract\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "draft",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<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,
      "dropped": false
    }
  ]
}

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

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

{
  "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
  }
}

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

Modèles

Dupliquer le modèle en une demande de signature

Crée une nouvelle demande de signature en dupliquant un modèle existant, y compris tous les champs, utilisateurs, rappels et paramètres.

Cachets. La nouvelle demande de signature reprend les participants de cachet du modèle et les champs du modèle qui leur appartiennent. Cette opération n’accepte pas la clé seal_participants. Pour les entreprises non activées pour les documents multiples, un cachet de modèle suit la version courante de sa lignée : si cette version courante est révoquée ou supprimée, ou si la lignée n’a pas de version courante, l’appel répond 409 SEAL_UNAVAILABLE et ne crée rien ; un cachet que l’entreprise de la clé API ne peut pas voir, ou qui est limité à un espace de travail autre que l’espace de travail cible, n’est pas copié, et ses champs non plus, et le 201 le liste dans seal_participants comme une entrée écartée ; si un cachet devait être conservé alors que les cachets d’organisation ne sont pas activés, l’appel répond 503 SEALS_DISABLED ; le 201 contient toujours seal_participants (un tableau vide lorsque le modèle n’a aucun participant de cachet). Pour les entreprises activées pour les documents multiples, la copie rattache telle quelle la version du cachet enregistrée dans le modèle, le 201 ne contient pas seal_participants, et un cachet qui a été remplacé, révoqué ou supprimé depuis l’enregistrement du modèle échoue à l’envoi de la demande.

POST

templates

{id}

duplicate

@firma-dev/sdk

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

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

const response = await firma.templates.duplicateTemplate({
    id: "id",
    name: "Q4 2025 Contract"
});
console.log(response);

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q4 2025 Contract"
}
'

import requests

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

payload = { "name": "Q4 2025 Contract" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Q4 2025 Contract'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate', 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}/duplicate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q4 2025 Contract'
  ]),
  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}/duplicate"

	payload := strings.NewReader("{\n  \"name\": \"Q4 2025 Contract\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/duplicate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q4 2025 Contract\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q4 2025 Contract\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "draft",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<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,
      "dropped": false
    }
  ]
}

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

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

{
  "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
  }
}

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

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

ID du modèle à dupliquer

Corps

application/json

name

string

Nom personnalisé pour la nouvelle demande de signature (par défaut, le nom du modèle)

Maximum string length: 255

Réponse

Modèle dupliqué avec succès en une nouvelle demande de signature

Détails du modèle dupliqué

string<uuid>

requis

ID de la nouvelle demande de signature créée

name

string

requis

Nom de la nouvelle demande de signature

status

string

requis

Statut de la nouvelle demande de signature

Exemple:

"draft"

workspace_id

string<uuid>

requis

Espace de travail auquel appartient la demande de signature

description

string | null

Description de la nouvelle demande de signature

created_date

string<date-time>

Horodatage de création

seal_participants

object[]

Participants de cachet de la nouvelle demande de signature : d'abord les entrées persistées (la forme des opérations de création, sauf que order peut être null) avec dropped: false, puis les entrées écartées. Renvoyé lorsque l'entreprise n'est pas activée pour les documents multiples : toujours présent, un tableau vide lorsque le modèle n'a aucun participant de cachet. Non renvoyé lorsque l'entreprise est activée pour les documents multiples.

Un participant de cachet persisté de la demande de signature dupliquée : toutes les clés de SealParticipantApi, plus dropped: false. order est normalement un entier et vaut null uniquement si la position n'a pas été renseignée lors de l'enregistrement du participant.

Option 1
Option 2

Show child attributes