Create Envelope

The Create Envelope endpoint creates a new envelope for one or more previously generated PDF documents.

Each document must include a sourceDocumentId, which is the document ID returned by the POST /v1/generate/pdf endpoint. Each document must also include one or more recipients.

This endpoint creates the envelope in the created status. See Envelope Statuses for more details about the envelope lifecycle. After calling this endpoint, you should use the POST /envelope/:id/send endpoint to send an email to the recipient with a link to the signing UI, where they can sign the document.

See the Getting Started guide for a complete example.

Endpoint

POSThttps://api.pdfgate.com/envelope

Examples

CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
copy-integration-source-code-icon

Request body fields

documents array of objects required
Array of documents to include in the envelope.
requesterName string required
Name of the user or system creating the envelope.
metadata object
Sets custom data.

Available responses