Send Envelope
Sends a draft envelope by updating its status to ‘sent’. Use this for envelopes that were created with status ‘created’.
Overview
- Purpose: Send a previously created draft envelope to recipients.
- Use Cases: Review-then-send workflow, scheduled sending, conditional sending based on business logic.
- API Method: PUT /envelopes/send
Required Input Fields
Envelope ID: The unique identifier of the draft envelope to send. The envelope must have status ‘created’.
Prerequisites
- Draft Status: The envelope must currently have status ‘created’ (draft mode).
- Complete Configuration: All required recipients and documents must be properly configured.
- Valid Recipients: All recipient email addresses must be valid.
Output
- Envelope ID: The envelope’s unique identifier.
- Status: Updated status, should be ‘sent’ after successful execution.
- Email Subject: The envelope’s email subject.
- Created DateTime: Original creation timestamp.
- Sent DateTime: Timestamp when envelope was sent (updated by this action).
- Status Changed DateTime: Updated to current timestamp.
Workflow Pattern
- Step 1: Create envelope with status ‘created’ to save as draft.
- Step 2: Review envelope contents, recipients, and configuration.
- Step 3: Use ‘Send Envelope’ to send to recipients when ready.
- Step 4: Track delivery and completion using ‘Get Envelope’.
Tips
[!TIP] Create envelopes with status ‘created’ to review before sending
[!TIP] Use this for approval workflows where envelopes need review before sending
[!TIP] Verify envelope configuration before sending to avoid errors
[!WARNING] Cannot send envelopes that are already sent or completed
[!WARNING] Sending is immediate - recipients will receive emails right away
[!TIP] Use ‘Get Envelope’ to verify the envelope was successfully sent
Need help? Have feedback?