Skip to main content
PATCH
@firma-dev/sdk

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

language
enum<string> | null

Idioma opcional de los correos para esta solicitud de firma. Cuando se establece, todos los correos dirigidos al firmante (y el formato de fecha) lo utilizan. Omítelo o usa null para volver al idioma predeterminado del espacio de trabajo y luego de la empresa (sin cambios de comportamiento).

Opciones disponibles:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl,
cs,
sv,
nl,
ro,
nb,
ca
completion_title
string | null

Encabezado mostrado en la página de finalización tras la firma. Null o una cadena vacía elimina la sobrescritura; si se omite, no cambia.

Maximum string length: 200
completion_message
string | null

Texto principal mostrado en la página de finalización tras la firma. Null o una cadena vacía elimina la sobrescritura; si se omite, no cambia.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

URL a la que se redirige al firmante desde la página de finalización. Debe usar https:// (http://localhost y http://127.0.0.1 también se aceptan en solicitudes de firma en modo de prueba). Null o una cadena vacía elimina la sobrescritura; si se omite, no cambia.

Maximum string length: 2000
completion_redirect_delay
integer | null

Segundos que espera la página de finalización antes de redirigir (0 redirige de inmediato). Solo se aplica cuando se resuelve una URL de redirección; la página usa 5 segundos cuando ningún nivel define un retraso. Null elimina la sobrescritura; si se omite, no cambia.

Rango requerido: 0 <= x <= 30

Respuesta

Solicitud de firma actualizada correctamente. La forma de la respuesta depende de lo que se actualizó: la actualización de propiedades devuelve {id, name, template_description, document_url, expiration_hours}; la actualización de un destinatario devuelve el objeto de destinatario completo; la actualización de un campo devuelve el objeto de campo completo; la actualización o el intercambio de un participante de sello devuelve { "seal_participant": <SealParticipantApi> }. La respuesta puede incluir un campo 'warning' para advertencias de validación del formato del correo electrónico (no bloqueantes).

Respuesta al actualizar propiedades

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