Merge API Documentation

Authentication: OAuth. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.

Sample use cases

List envelopes pending signature for over 5 days and resend the email.
Send the Q2 Renewal template to the contacts on this list with their renewal date prefilled.
Pull every completed envelope in the last 30 days for the audit log.

Available Tools

list_documents

List all documents in an envelope with document IDs and metadata.

get_document

Download a specific document as base64 PDF. Use ‘combined’ for all docs, ‘certificate’ for signing cert.

download_all_documents

Download all documents as combined PDF or ZIP archive. Returns base64 content.

add_document

Add a document to a draft envelope. Document must be base64 encoded. Only works on draft envelopes (status=‘created’).

delete_document

Delete a document from a draft envelope. Only works on draft envelopes (status=‘created’).

list_envelopes

List envelopes with date/status/folder filters. Use from_date for recent envelopes.

get_envelope

Get envelope details including status, recipients, and documents.

create_envelope

Create envelope from documents or template. Set status=‘sent’ to send immediately.

send_envelope

Send a draft envelope to recipients. Changes status from ‘created’ to ‘sent’.

resend_envelope

Resend email notifications to pending recipients who haven’t signed yet. Only works for ‘sent’ or ‘delivered’ envelopes.

void_envelope

Void an in-progress envelope with a reason. Only ‘sent’ or ‘delivered’ envelopes can be voided. Cannot void completed, voided, or draft envelopes.

get_envelope_audit_events

Get audit trail/history showing all events for an envelope.

get_form_data

Get filled form/tab data from a completed or in-progress envelope. Returns all field values entered by recipients.

list_recipients

List envelope recipients with signing status. Includes signers, CC, and certified delivery.

update_recipients

Update recipient email/name to correct errors. Use resend_envelope=true to notify after update. Only works for ‘created’, ‘sent’, or ‘delivered’ envelopes.

create_signing_url

Create embedded signing URL for a recipient. Envelope must be ‘sent’ status (not draft). Requires clientUserId to match envelope.

delete_recipient

Delete a recipient from an envelope. Only works on draft envelopes (status=‘created’).

list_templates

List available templates with optional search and folder filters.

create_template

Create a new template with documents and recipient roles for reusable envelope configurations.

delete_template

Delete a template by moving it to the recycle bin. Templates are retained for 24 hours before permanent deletion.

get_template

Get template details including roles, documents, and tabs configuration.