Envelopes

La Guía de Integración cubre el flujo mínimo: crear, distribuir, consultar estado y descargar. Este recurso documenta el resto de las operaciones sobre un envelope — listar con filtros, actualizar, cancelar, duplicar, reenviar y consultar varios a la vez.

Listar envelopes

GET /envelope

Devuelve una lista paginada. Acepta estos parámetros de consulta:

Parámetro	Valores	Descripción
query	texto	Búsqueda libre por título u otros campos indexados.
page / perPage	número	Paginación (perPage por defecto 10).
type	DOCUMENT, TEMPLATE	Filtra por tipo de envelope.
templateId	número	Solo envelopes creados a partir de esa plantilla.
source	DOCUMENT, TEMPLATE, TEMPLATE_DIRECT_LINK	Filtra por origen de creación.
status	DRAFT, PENDING, COMPLETED, REJECTED, CANCELLED	Filtra por estado.
hasExpiredRecipients	true, false	Solo envelopes con algún destinatario cuyo enlace de firma expiró.
folderId	string	Filtra por carpeta.
orderByColumn / orderByDirection	createdAt / asc, desc	Orden del listado.

Ver la especificación completa en la Referencia de la API.

Consultar varios envelopes

POST /envelope/get-many

Recibe un arreglo ids y devuelve el detalle de cada uno en una sola llamada — útil para evitar N llamadas a GET /envelope/{envelopeId} cuando ya tienes los IDs (por ejemplo, después de crear varios documentos desde una plantilla).

Ver la especificación completa en la Referencia de la API.

Actualizar un envelope

POST /envelope/update

Modifica data (propiedades del envelope, como title o externalId) y/o meta (asunto, mensaje, redirectUrl, etc.) de un envelope existente. Solo tiene efecto mientras el envelope está en DRAFT — una vez distribuido, estas propiedades quedan fijas.

Ver la especificación completa en la Referencia de la API.

Cancelar un envelope

POST /envelope/cancel

Cancela un envelope en curso (DRAFT o PENDING), con un reason opcional. A diferencia de un rechazo (que lo origina un destinatario), la cancelación la origina el dueño del envelope.

Ver la especificación completa en la Referencia de la API.

Eliminar un envelope

POST /envelope/delete

Elimina un envelope. Un envelope COMPLETED no se puede eliminar — cancélalo antes si todavía no llegó a ese estado.

Ver la especificación completa en la Referencia de la API.

Duplicar un envelope

POST /envelope/duplicate

Crea una copia de un envelope existente. Los flags includeRecipients e includeFields controlan si la copia trae también los destinatarios y campos originales, o queda en blanco para configurarla desde cero.

Ver la especificación completa en la Referencia de la API.

Reenviar a destinatarios pendientes

POST /envelope/redistribute

Vuelve a notificar a destinatarios específicos de un envelope ya distribuido — por ejemplo, si no vieron el correo original o su enlace expiró. Recibe recipients, la lista de destinatarios a renotificar.

Ver la especificación completa en la Referencia de la API.

---

Ver también

• Destinatarios — agregar y gestionar quién firma
• Campos — tipos de campo y sus opciones
• Plantillas — crear envelopes reutilizables