Copiar plantilla a otro espacio de trabajo

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
    }
  ]
}

Plantillas

Copiar plantilla a otro espacio de trabajo

Crea una copia completa de una plantilla (incluidos los campos, destinatarios, CC, recordatorios, definiciones de campos personalizados y el documento PDF) en un espacio de trabajo de destino de la misma empresa. Requiere una clave API protegida a nivel de empresa. Multidocumento (requiere habilitación): la copia de una plantilla con más de un documento es una plantilla con UN solo documento, el documento combinado de la plantilla de origen; se conservan su contenido y los números de página absolutos de sus campos, pero no las etiquetas ni las posiciones de cada documento.

POST

templates

{id}

copy

Copiar plantilla a otro espacio de trabajo

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
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

string<uuid>

requerido

ID de la plantilla que se copiará

Cuerpo

application/json

workspace_id

string<uuid>

requerido

ID del espacio de trabajo de destino al que se copiará la plantilla

name

string

Nombre de la plantilla copiada (por defecto, el nombre original con el sufijo " (copy)")

Maximum string length: 255

Respuesta

Plantilla copiada correctamente

Respuesta de copia de plantilla

string<uuid>

requerido

ID de la nueva copia de la plantilla

name

string

requerido

Nombre de la plantilla copiada

workspace_id

string<uuid>

requerido

Espacio de trabajo de destino al que se copió la plantilla

created_date

string<date-time>

requerido

Marca de tiempo de creación

seal_participants

object[]

requerido

Una entrada por cada participante de sello activo de la plantilla de origen, en el orden de origen. Un sello que no está disponible en el espacio de trabajo de destino no se copia, ni tampoco los campos asignados a él; su entrada es { id: null, order: null, seal: <resumen o null>, seal_out_of_scope: true, dropped: true }.

Un participante de sello de la plantilla copiada. order es su posición en la plantilla copiada; seal_out_of_scope es true solo cuando el sello se ha revocado o borrado.

Option 1
Option 2

Show child attributes