Copy template to another workspace

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Template Copy"
}
'

import requests

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

payload = {
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Template Copy"
}
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({workspace_id: '550e8400-e29b-41d4-a716-446655440000', name: 'My Template Copy'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy', 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}/copy",
  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([
    'workspace_id' => '550e8400-e29b-41d4-a716-446655440000',
    'name' => 'My Template Copy'
  ]),
  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}/copy"

	payload := strings.NewReader("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\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}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}"

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

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

Templates

Copy template to another workspace

Deep-copies a template (including fields, recipients, CC, reminders, custom field definitions, and the PDF document) to a target workspace within the same company. Requires a company-level (protected) API key. Multi-document (enablement required): the copy of a template with more than one document is a template with ONE document, the merged document of the source; its content and the absolute page numbers of its fields are kept, the per-document labels and positions are not carried.

POST

templates

{id}

copy

Copy template to another workspace

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Template Copy"
}
'

import requests

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

payload = {
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Template Copy"
}
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({workspace_id: '550e8400-e29b-41d4-a716-446655440000', name: 'My Template Copy'})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/copy', 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}/copy",
  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([
    'workspace_id' => '550e8400-e29b-41d4-a716-446655440000',
    'name' => 'My Template Copy'
  ]),
  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}/copy"

	payload := strings.NewReader("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\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}/copy")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workspace_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"name\": \"My Template Copy\"\n}"

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

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

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 copy

Body

application/json

workspace_id

string<uuid>

required

Target workspace ID to copy the template into

name

string

Name for the copied template (defaults to original name with " (copy)" suffix)

Maximum string length: 255

Response

Template copied successfully

Template copy response

string<uuid>

required

ID of the newly created template copy

name

string

required

Name of the copied template

workspace_id

string<uuid>

required

Target workspace the template was copied to

created_date

string<date-time>

required

Creation timestamp

seal_participants

object[]

required

One entry per active seal participant of the source template, in source order. A seal that is not available in the target workspace is not copied, nor are the fields assigned to it; its entry is { id: null, order: null, seal: <summary or null>, seal_out_of_scope: true, dropped: true }.

A seal participant of the copied template. order is its position in the copied template; seal_out_of_scope is true only when the seal has been revoked or deleted.

Option 1
Option 2

Show child attributes