Send one PDF to multiple signers
create_envelopeSend a single PDF to 2–10 signers as one envelope. This is the multi-signer counterpart to create_signature_request, which handles exactly one signer — the API rejects an envelope with fewer than two recipients, so pick the tool by signer count. routing 'parallel' (default) emails everyone at once and each signs independently; routing 'sequential' emails only the lowest-order recipient and activates the rest one at a time as each preceding signer finishes, which is what you want for approve-then-countersign chains. The source is either a render you own (renderId) or a PDF fetched from a public URL (pdfUrl) — supply exactly one. Pass preview: true to create the envelope and get every sign URL back WITHOUT sending any email and WITHOUT consuming quota; do that first if you are unsure about field placement. A real send emails the recipients immediately and consumes one signature from the monthly quota PER recipient (free tier: 10 signatures/month, then per-signature billing). Returns { envelope, recipients: [...] } with a sign_url per recipient. Requires a Kamy API key with the signatures:write scope; without a key, returns dashboard setup instructions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pdfUrl | No | Publicly fetchable PDF URL. Kamy downloads it and stores it as a render first. Supply exactly one of renderId or pdfUrl. | |
| message | No | Message included in every invitation email. | |
| preview | No | When true, creates the envelope and returns every sign URL WITHOUT emailing anyone and without consuming signature quota. Use it to check placement and routing before the real send. | |
| routing | No | 'parallel' (default) emails everyone at once and each signs independently. 'sequential' emails only the lowest-order recipient; the rest are created with status 'waiting' and activated one at a time as the preceding signer completes. | parallel |
| ccEmails | No | Up to 10 observers CC'd on the invitations. Not signers. | |
| position | No | Default signature placement in PDF points, origin bottom-left. | |
| renderId | No | UUID of a completed render owned by this account. Supply exactly one of renderId or pdfUrl. | |
| expiresIn | No | Sign-link lifetime in seconds. Min 1 hour, max 30 days. | |
| recipients | Yes | 2–10 signers. The route rejects a single recipient — use create_signature_request for one signer. | |
| placedFields | No | Up to 100 sender-placed form fields for signers to complete. |