Mettre à Jour Partiellement une Demande de Signature
Met à jour les propriétés de la demande de signature, un seul destinataire, OU un seul champ. Impossible de mettre à jour plusieurs types d’entités dans une même requête. Impossible de mettre à jour après que la demande de signature a été envoyée, terminée ou annulée, sauf pour un échange de cachet (voir seal_participant). Un seal_participant qui désigne un cachet répond 404 NOT_FOUND lorsque le cachet n’existe pas ou appartient à une autre entreprise, et 400 SEAL_UNAVAILABLE lorsque le cachet est révoqué, supprimé ou n’est pas la version courante de sa lignée, et aussi lorsqu’il est limité à un espace de travail autre que celui de la demande de signature. Ces réponses valent pour l’ajout d’un participant de cachet et pour le changement de son cachet. Un échange de cachet (swap_to_seal_id) répond différemment pour le nouveau cachet : 404 NOT_FOUND lorsqu’il n’existe pas, appartient à une autre entreprise ou est limité à un espace de travail autre que celui de la demande de signature ; 409 SEAL_UNAVAILABLE lorsqu’il est révoqué, supprimé ou n’est pas la version courante de sa lignée ; 400 SEAL_FIELD_REQUIRED lorsque le participant de cachet n’a pas de champ de cachet sur la demande de signature. Ajouter un participant de cachet ou changer son cachet répond 503 SEALS_DISABLED lorsque les cachets d’organisation ne sont pas activés. Ajouter un participant de cachet exige order (voir le contrat d’ordre). Un champ qui appartient à un participant de cachet n’accepte que les changements de position et de page_number ; toute autre clé de field, recipient_id comprise, est ignorée.
Autorisations
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 de la demande de signature
Corps
- Option 1
- Option 2
- Option 3
- Option 4
Mettre à jour uniquement les propriétés de la demande de signature
Nouveau nom pour la demande de signature
255Nouvelle description
Remplace le document par un nouveau PDF encodé en base64. Le nombre de pages est extrait automatiquement.
Nouvelles heures d'expiration
x >= 1Mettre à jour les paramètres
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é).
en, es, it, pt, fr, de, el, ru, pl, cs, sv, nl, ro, nb, ca Titre affiché sur la page de finalisation après la signature. Null ou une chaîne vide supprime la surcharge ; omis, il reste inchangé.
200Texte principal affiché sur la page de finalisation après la signature. Null ou une chaîne vide supprime la surcharge ; omis, il reste inchangé.
1000URL 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.
2000Secondes 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é.
0 <= x <= 30Réponse
Demande de signature mise à jour avec succès. La forme de la réponse dépend de ce qui a été mis à jour : la mise à jour des propriétés renvoie {id, name, template_description, document_url, expiration_hours} ; la mise à jour d'un destinataire renvoie l'objet destinataire complet ; la mise à jour d'un champ renvoie l'objet champ complet ; la mise à jour ou l'échange d'un participant de cachet renvoie { "seal_participant": <SealParticipantApi> }. La réponse peut contenir un champ 'warning' pour les avertissements de validation du format de l'e-mail (non bloquants).