Clicksign icon

Clicksign

Interact with Clicksign API

Envelope → Atualizar

AI-generated

Summary

Update an existing envelope in Clicksign by specifying its ID and optionally modifying its properties such as name, language, auto-close setting, reminder interval, refusal behavior, deadline, default email subject and message, and folder ID.

Inputs

  • Envelope ID (required) — ID of the envelope to update.
  • Nome — New name for the envelope.
  • Idioma — Language used in emails, signing page, and document logs (options: pt-BR, en-US).
  • Finalizar Automaticamente Após Todos Assinarem — Whether the envelope should be automatically closed after the last signer signs (default true).
  • Intervalo De Lembrete — Interval in days for automatic reminders (integer, values like 1,2,3,7,14).
  • Bloqueio De Assinatura Após Recusa Por Signatário — Whether signing should be blocked if a signer refuses.
  • Prazo Final — Deadline date and time for the envelope and its documents (RFC 3339 format).
  • Assunto Padrão — Default email subject sent to signers when requesting signatures.
  • Mensagem Padrão — Default message sent to signers.
  • Pasta ID — ID of the folder containing the envelope.

Output shape

a single record representing the updated envelope resource

The operation returns the updated envelope data as a JSON object. If an error occurs, it is returned as an error envelope.

Discussion