Authentication: OAuth. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.
Q2 Renewal template to the contacts on this list with their renewal date prefilled.List all documents in an envelope with document IDs and metadata.
Download a specific document as base64 PDF. Use ‘combined’ for all docs, ‘certificate’ for signing cert.
Download all documents as combined PDF or ZIP archive. Returns base64 content.
Add a document to a draft envelope. Document must be base64 encoded. Only works on draft envelopes (status=‘created’).
Delete a document from a draft envelope. Only works on draft envelopes (status=‘created’).
List envelopes with date/status/folder filters. Use from_date for recent envelopes.
Get envelope details including status, recipients, and documents.
Create envelope from documents or template. Set status=‘sent’ to send immediately.
Send a draft envelope to recipients. Changes status from ‘created’ to ‘sent’.
Resend email notifications to pending recipients who haven’t signed yet. Only works for ‘sent’ or ‘delivered’ envelopes.
Void an in-progress envelope with a reason. Only ‘sent’ or ‘delivered’ envelopes can be voided. Cannot void completed, voided, or draft envelopes.
Get audit trail/history showing all events for an envelope.
Get filled form/tab data from a completed or in-progress envelope. Returns all field values entered by recipients.
List envelope recipients with signing status. Includes signers, CC, and certified delivery.
Update recipient email/name to correct errors. Use resend_envelope=true to notify after update. Only works for ‘created’, ‘sent’, or ‘delivered’ envelopes.
Create embedded signing URL for a recipient. Envelope must be ‘sent’ status (not draft). Requires clientUserId to match envelope.
Delete a recipient from an envelope. Only works on draft envelopes (status=‘created’).
List available templates with optional search and folder filters.
Create a new template with documents and recipient roles for reusable envelope configurations.
Delete a template by moving it to the recycle bin. Templates are retained for 24 hours before permanent deletion.
Get template details including roles, documents, and tabs configuration.