Create Envelope | propelone

This endpoint expects a multipart form.

expires_atstringRequired

Optional: Envelope-wide expiration - date format - must be in the future

document_idstringRequired

Required: Document UUID - exists:documents,id - must have signers configured

signing_modestringRequired

Optional: Order in which signers receive the envelope - in: SEQUENTIAL|PARALLEL - default: SEQUENTIAL

parent_record_idstringRequired

Optional: Parent record UUID - required_with parent_record_type

parent_record_typestringRequired

Optional: Polymorphic parent alias - required_with parent_record_id

signers[0][expires_at]stringRequired

Optional per signer: Per-signer expiry override - date format - must be in the future

signers[0][document_signer_id]stringRequired

Required per signer: Document signer UUID - exists:document_signers,id - must cover every DocumentSigner row on the document

signers[0][recipient][recipient_name]stringRequired

Optional per signer: Recipient name snapshot - max 255 chars

signers[0][recipient][recipient_email]stringRequired

Optional per signer: Recipient email - valid email - max 255 chars

signers[0][recipient][recipient_phone]stringRequired

Optional per signer: Recipient phone - max 32 chars

signers[0][channel_flags][send_via_sms]stringRequired

Optional per signer: SMS channel flag - boolean

signers[0][channel_flags][send_via_email]stringRequired

Optional per signer: Email channel flag - boolean - default: email-only when channel_flags omitted

signers[0][channel_flags][send_via_portal]stringRequired

Optional per signer: Portal channel flag - boolean

signers[0][channel_flags][send_via_postal]stringRequired

Optional per signer: Postal channel flag - boolean

signers[0][recipient][is_external_recipient]stringRequired

Optional per signer: External-recipient flag - boolean

signers[0][recipient][recipient_customer_id]stringRequired

Optional per signer: CRM customer UUID - exists:customers,id

signers[0][recipient][external_recipient_label]stringRequired

Optional per signer: External recipient label - max 255 chars

signers[0][recipient][recipient_customer_contact_id]stringRequired

Optional per signer: CRM customer contact UUID

signers[0][recipient][recipient_customer_location_id]stringRequired

Optional per signer: CRM customer location UUID

Successful response

1	curl -X POST https://https//https/documents/envelopes \
2	-H "{{tenant_key_name}}: {{tenant_key_value1}}\|{{tenant_key_value2}}" \
3	-H "Content-Type: multipart/form-data" \
4	-F expires_at="2024-12-31T23:59:59Z" \
5	-F document_id="a3f1c9e2-4b7d-4f8a-9c2e-123456789abc" \
6	-F signing_mode="SEQUENTIAL" \
7	-F parent_record_id="d9f8a7b6-c5d4-4e3f-8a7b-9876543210fe" \
8	-F parent_record_type="contract" \
9	-F signers[0][expires_at]="2024-12-15T23:59:59Z" \
10	-F signers[0][document_signer_id]="b7e3d2c1-9a8b-4c7d-8e9f-abcdef123456" \
11	-F signers[0][recipient][recipient_name]="Jane Doe" \
12	-F signers[0][recipient][recipient_email]="jane.doe@example.com" \
13	-F signers[0][recipient][recipient_phone]="+14155552671" \
14	-F signers[0][channel_flags][send_via_sms]="true" \
15	-F signers[0][channel_flags][send_via_email]="true" \
16	-F signers[0][channel_flags][send_via_portal]="false" \
17	-F signers[0][channel_flags][send_via_postal]="false" \
18	-F signers[0][recipient][is_external_recipient]="false" \
19	-F signers[0][recipient][recipient_customer_id]="c1234567-89ab-4def-0123-456789abcdef" \
20	-F signers[0][recipient][external_recipient_label]="Primary Contact" \
21	-F signers[0][recipient][recipient_customer_contact_id]="d2345678-9abc-4def-1234-56789abcdef0" \
22	-F signers[0][recipient][recipient_customer_location_id]="e3456789-abcd-4def-2345-6789abcdef01"