Invitations

Invitations — 9 endpoints

Send, extend, and remind signing invitations

• POST /api/v1/invitations — Send Invitation

  Send a signing invitation to a recipient for a specific envelope. The recipient receives an email or SMS with a link to sign the document.

• POST /api/v1/invitations/bulk/send — Send Bulk Invitations

  Send signing invitations to multiple recipients across multiple envelopes in a single API call. Useful for high-volume signing workflows.

• POST /api/v1/invitations/envelope — Send Invitation by Envelope

  Send signing invitations for all signers defined within a specific envelope. This triggers invitation dispatch for all pending signers in the envelope.

• PUT /api/v1/invitations/extend — Extend Single Invitation

  Extend the expiry date of a single signing invitation. Use this to give a signer more time to complete signing before the invitation expires.

• PUT /api/v1/envelopes/extend-invitations — Extend Envelope Invitations

  Extend the expiry dates of all pending invitations within a specific envelope. This is useful when you need to give all signers more time.

• POST /api/v1/invitations/reminders/send — Send Reminder

  Send a reminder notification to a signer who has not yet completed signing. The reminder is sent via the same channel as the original invitation.

• POST /api/v1/invitations/bulk/reminders/send — Send Bulk Reminders

  Send reminder notifications to multiple signers in a single request. Use this for batch follow-up campaigns.

• POST /api/v2/invitations — Send Invitation V2

  Version 2 of the Send Invitation API. Unlike previous versions, this endpoint does not send notifications via email or SMS. Instead, it returns the signing link directly in the API response, allowing clients to handle notification delivery and user communication through their own channels.

• POST /api/v3/invitations — Send Invitation V3

  Version 3 of the Send Invitation API. This endpoint sends notifications to recipients via email or SMS and also returns the signing link directly in the API response, allowing clients to both rely on built-in notifications and handle additional communication through their own channels if needed.