Clicksign icon

Clicksign

Interact with Clicksign API

Envelope → Criar

AI-generated

Summary

Create a new envelope in Clicksign with specified metadata such as name, language, auto-close behavior, reminder interval, refusal blocking, deadline, email subject, message, and folder ID.

Inputs

  • Nome (required) — Name of the envelope to create.
  • Idioma (required) — Language used in emails, signing page, and document logs; options are Portuguese (pt-BR) or English (en-US).
  • Finalizar Automaticamente Após Todos Assinarem — Boolean to auto-close the envelope automatically once the last signer completes signing.
  • Intervalo De Lembrete (required) — Integer defining the interval in days for automatic reminder emails (valid values include 1, 2, 3, 7, 14).
  • Bloqueio De Assinatura Após Recusa Por Signatário — Boolean to pause the signing process if a signer refuses to sign.
  • Prazo Final — Deadline date-time in RFC 3339 format, setting the expiration date for the envelope and its documents.
  • Assunto Padrão — Default email subject sent to signers when requesting signatures.
  • Mensagem Padrão — Default message body sent to signers with the signature request email.
  • Pasta ID — ID of the folder where the envelope will be stored.

Output shape

a single record

Returns the created envelope object as a JSON record. No pagination or array output.

Discussion