Newer Version Available
Envelope Send Input
- JSON example
-
1{ 2 "emailSettings" : { // API: required, UI: required 3 "emailSubject": "",// API: required, 4 "emailBody": "" 5 }, 6 "vendor": "Docusign",// API: required, 7 "recipients": {// API: required, 8 "signers": [{// API: required, 9 "name": "",// API: required, 10 "email": "",// API: required, 11 "routingOrder": "",// API: required, 12 "recipientId": "",// API: required, 13 "signerRole": "",// API: required, 14 "recipientType": "",// API: required, 15 "recipientLocale": "", 16 "phone": "", 17 "emailNotification": { 18 "emailSubject": "", 19 "emailBody": "", 20 "supportedLanguage": "" 21 } 22 } 23 ], 24 "inPersonSigners": [{ 25 "name": "", 26 "email": "", 27 "routingOrder": "", 28 "recipientId": "", 29 "signerRole": "", 30 "emailNotification": { 31 "emailSubject": "", 32 "emailBody": "", 33 "supportedLanguage": "" 34 } 35 } 36 ], 37 "certifiedDeliveries": [{ 38 "name": "", 39 "email": "", 40 "routingOrder": "", 41 "recipientId": "", 42 "signerRole": "", 43 "emailNotification": { 44 "emailSubject": "", 45 "emailBody": "", 46 "supportedLanguage": "" 47 } 48 } 49 ], 50 "carbonCopies": [{ 51 "name": "", 52 "email": "", 53 "routingOrder": "", 54 "recipientId": "", 55 "signerRole": "", 56 "emailNotification": { 57 "emailSubject": "", 58 "emailBody": "", 59 "supportedLanguage": "" 60 } 61 } 62 ] 63 }, 64 "documents": [{ // API: required 65 "name": "",// API: required, 66 "sourceId": "",// API: required, 67 "fileExtension": "",// API: required, 68 "sourceType": "",// API: required, 69 "documentId": ""// API: required, 70 } 71 ], 72 "notificationSettings": { 73 "useAccountDefaults": "", 74 "reminders": { 75 "reminderEnabled": "", 76 "reminderDelay": "", 77 "reminderFrequency": "" 78 }, 79 "expirations": { 80 "expireEnabled": "", 81 "expireAfter": "", 82 "expireWarn": "" 83 } 84 } 85} - Properties
-
Name Type Description Required or Optional Available Version documents Envelope Send Documents Request[] Array of documents to send. Required 56.0 emailSettings Envelope Send Email Settings Request Email settings. Required 56.0 notificationSettings Envelope Send Notification Request Notification settings. Optional 56.0 parentId String ID of the parent object. Optional 56.0 recipients Envelope Send Recipients Request Map of different recipients. Required 56.0 vendor String Vendor name. Required 56.0