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

Templates

Duplicate template into signing request

Creates a new signing request by duplicating an existing template, including all fields, users, reminders, and settings.

Seals. The new signing request carries the template’s seal participants and the template fields that belong to them. This operation takes no seal_participants key. While multi-document editing is suspended, templates on the multi-document read-only path answer 409 MULTI_DOCUMENT_READ_ONLY. For templates on the single-document path during that suspension, a template seal follows the current version of its lineage: if that current version is revoked or deleted, or the lineage has no current version, the call answers 409 SEAL_UNAVAILABLE and creates nothing; a seal that the API key’s company cannot see, or that is limited to a workspace other than the target workspace, is not copied and neither are its fields, and the 201 lists it in seal_participants as a dropped entry; if a seal would be kept while organization seals are not enabled, the call answers 503 SEALS_DISABLED; the 201 always carries seal_participants (an empty array when the template has no seal participants). For every company during normal operation, the copy attaches the template’s stored seal version as it is, the 201 does not carry seal_participants, and a seal that was replaced, revoked or deleted since the template was saved fails when the request is sent.

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

Authorizations

Authorization

string

header

required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

string<uuid>

required

Template ID to duplicate

Body

application/json

name

string

Custom name for the new signing request (defaults to template name)

Maximum string length: 255

Response

Template duplicated successfully into a new signing request

Duplicated template details

string<uuid>

required

ID of the newly created signing request

name

string

required

Name of the new signing request

status

string

required

Status of the new signing request

Example:

"draft"

workspace_id

string<uuid>

required

Workspace the signing request belongs to

description

string | null

Description of the new signing request

created_date

string<date-time>

Creation timestamp

seal_participants

object[]

Seal participants of the new signing request, persisted entries (the shape of the create operations, except that order can be null) with dropped: false, then dropped entries. Not answered during normal operation for any company. While multi-document editing is suspended, duplication of a template on the multi-document read-only path answers 409 MULTI_DOCUMENT_READ_ONLY; on the single-document path, this key is always present, an empty array when the template has no seal participants.

A persisted seal participant of the duplicated signing request: every key of SealParticipantApi, plus dropped: false. order is normally an integer and is null only if the position was not reported when the participant was saved.

Option 1
Option 2

Show child attributes