Skip to main content
PATCH
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

ID de la demande de signature

Corps

application/json

Mettre à jour uniquement les propriétés de la demande de signature

name
string

Nouveau nom pour la demande de signature

Maximum string length: 255
description
string

Nouvelle description

document
string<byte>

Remplace le document par un nouveau PDF encodé en base64. Le nombre de pages est extrait automatiquement.

expiration_hours
integer

Nouvelles heures d'expiration

Plage requise: x >= 1
settings
object

Mettre à jour les paramètres

language
enum<string> | null

Langue facultative des e-mails pour cette demande de signature. Lorsqu'elle est définie, tous les e-mails destinés au signataire (et le format de date) l'utilisent. Omettez-la ou utilisez null pour revenir à la langue par défaut de l'espace de travail, puis de l'entreprise (comportement inchangé).

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

Titre affiché sur la page de finalisation après la signature. Null ou une chaîne vide supprime la surcharge ; omis, il reste inchangé.

Maximum string length: 200
completion_message
string | null

Texte principal affiché sur la page de finalisation après la signature. Null ou une chaîne vide supprime la surcharge ; omis, il reste inchangé.

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

URL vers laquelle le signataire est redirigé depuis la page de finalisation. Doit utiliser https:// (http://localhost et http://127.0.0.1 sont également acceptés sur les demandes de signature en mode test). Null ou une chaîne vide supprime la surcharge ; omise, elle reste inchangée.

Maximum string length: 2000
completion_redirect_delay
integer | null

Secondes d'attente de la page de finalisation avant redirection (0 redirige immédiatement). S'applique uniquement lorsqu'une URL de redirection est résolue ; la page utilise 5 secondes lorsqu'aucun niveau ne définit de délai. Null supprime la surcharge ; omis, il reste inchangé.

Plage requise: 0 <= x <= 30

Réponse

Demande de signature mise à jour avec succès. La forme de la réponse dépend de ce qui a été mis à jour : une mise à jour des propriétés renvoie {id, name, template_description, document_url, expiration_hours} ; une mise à jour de destinataire renvoie l'objet destinataire complet ; une mise à jour de champ renvoie l'objet champ complet. La réponse peut inclure un champ 'warning' pour les avertissements de validation de format d'email (non bloquant).

Réponse lors de la mise à jour des propriétés

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