Saltar al contenido principal
PATCH
/
signing-requests
/
{id}
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

const response = await firma.signingRequests.patchSigningRequest({
    id: "id",
    body: {
        name: "Updated Contract Name",
        expiration_hours: 72
    }
});
console.log(response);
curl --request PATCH \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Updated Contract Name",
"expiration_hours": 72
}
'
import requests

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

payload = {
"name": "Updated Contract 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 Contract Name', expiration_hours: 72})
};

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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/signing-requests/{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 Contract 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/signing-requests/{id}"

payload := strings.NewReader("{\n \"name\": \"Updated Contract 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/signing-requests/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated Contract Name\",\n \"expiration_hours\": 72\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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 Contract Name\",\n \"expiration_hours\": 72\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "template_description": "<string>",
  "document_url": "<string>",
  "expiration_hours": 123
}

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

id
string<uuid>
requerido

ID de la Solicitud de Firma

Cuerpo

application/json

Actualizar solo las propiedades de la Solicitud de Firma

name
string

Nuevo nombre para la solicitud de firma

Maximum string length: 255
description
string

Nueva descripción

document
string<byte>

Reemplaza el documento con un nuevo PDF codificado en base64. El número de páginas se extraerá automáticamente.

expiration_hours
integer

Nuevas horas de expiración

Rango requerido: x >= 1
settings
object

Actualizar configuración

Respuesta

Solicitud de firma actualizada correctamente. La forma de la respuesta depende de lo que se haya actualizado: la actualización de propiedades devuelve {id, name, template_description, document_url, expiration_hours}; la actualización de destinatario devuelve el objeto de destinatario completo; la actualización de campo devuelve el objeto de campo completo. La respuesta puede incluir un campo 'warning' para advertencias de validación de formato de correo electrónico (no bloqueante).

Respuesta al actualizar propiedades

id
string<uuid>
name
string
template_description
string | null
document_url
string<uri>
expiration_hours
integer