Docusign integration error
The request contained at least one invalid parameter. 'recipients' may not be specifed when 'templateId' is set. Use 'templateRoles'.
I'm getting this as REST post response in docusign response.
Accepted Solution
It's fixed needed to remove templateID
here is the request which am sending :-
/***********************/
here is the request which am sending :-
/***********************/
{
"templateId": "15561217-3fb2-415a-8a8a-e0321216407b",
"status": "sent",
"emailSubject": "Email Subject..",
"templateRoles": [
{
"email": " Proprietary information hidden",
"roleName": "Employee",
"name": "Trip"
}
],
"emailBlurb": "Email Body..",
"notification": {
"reminders": {
"reminderDelay": "1",
"reminderEnabled": "true",
"reminderFrequency": "1"
},
"expirations": {
"expireEnabled": "true",
"expireWarn": "1",
"expireAfter": "2"
}
},
"eventNotification": {
"requireAcknowledgement": "true",
"url": "http://localhost:8080/prweb/PRRestService/DocuSignService/Services/pyConnect",
"envelopeEvents": [
{
"envelopeEventStatusCode": "completed",
"includeDocuments": "true"
}
],
"includeTimeZone": "true",
"loggingEnabled": "true",
"recipientEvents": [
{
"recipientEventStatusCode": "Delivered",
"includeDocuments": "true"
}
],
"includeCertificateOfCompletion": "true",
"includeDocuments": "true"
},
"documents": [
{
"documentId": "1",
"name": "Trip.pdf",
"fileExtension": "pdf",
"documentBase64": "JVBERi0xLjMNJeLjz9MNCjcgMCBvYmoNPDwvTGluZWFyaXplZCAxL0wgNzk0NS9PIDkvRSAzNTI0L04gMS9UIDc2NTYvSCBbIDQ1MSAxMzddPj4NZW5kb2JqDSAgICAgICAgICAgICAgICAgICAgICAgDQoxMyAwIG9iag08PC9EZWNvZGVQYXJtczw8L0NvbHVtbnMgNC9QcmVkaWN0b3IgMTI+Pi9GaWx0ZXIvRmxhdGVEZWNvZGUvSURbPDREQzkxQTE4NzVBNkQ3MDdBRUMyM"
}
],
"customFields": {
"textCustomFields": [
{
"value": "LSA-FW-MISSIONFW-WORK M-472",
"name": "WorkObjectHandle",
"show": "false",
"required": "true"
}
]
},
"recipients": {
"carbonCopies": [
{
"email": " Proprietary information hidden",
"routingOrder": "1",
"name": "KLKL slss",
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232"
}
],
"signers": [
{
"email": " Proprietary information hidden",
"deliveryMethod": "Email",
"smsAuthentication": {
"senderProvidedNumbers": [
"",
""
]
},
"routingOrder": "1",
"name": "KLKL slss",
"requireIdLookup": "false",
"tabs": {
"checkboxTabs": [
{
"documentId": "DOCUMENT_ID_TO_MAP_THIS_TAB_TO",
"shared": "ENABLE_FIELD_MARKUP(TRUE/FALSE)",
"yPosition": "VERTICAL_OFFSET_OF_THE_TAB_ON_THE_PAGE",
"name": "TOOL_TIP_OF_THE_TAB",
"tabLabel": "LABEL_USED_FOR_THE_TAB",
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232",
"selected": "SELECT_THE_CHECKBOX(TRUE/FALSE)",
"pageNumber": "PAGE_NUMBER_ON_DOCUMENT",
"xPosition": "HORIZONTAL_OFFSET_OF_THE_TAB_ON_THE_PAGE"
}
],
"textTabs": [
{
"documentId": "DOCUMENT_ID_TO_MAP_THIS_TAB_TO",
"width": "200",
"height": "200",
"yPosition": "VERTICAL_OFFSET_OF_THE_TAB_ON_THE_PAGE",
"value": "VALUE_OF_THE_TAB",
"name": "TOOL_TIP_OF_THE_TAB",
"tabLabel": "LABEL_USED_FOR_THE_TAB",
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232",
"pageNumber": "PAGE_NUMBER_ON_DOCUMENT",
"xPosition": "HORIZONTAL_OFFSET_OF_THE_TAB_ON_THE_PAGE"
}
],
"emailTabs": [
{
"documentId": "DOCUMENT_ID_TO_MAP_THIS_TAB_TO",
"width": "200",
"height": "200",
"yPosition": "VERTICAL_OFFSET_OF_THE_TAB_ON_THE_PAGE",
"name": "TOOL_TIP_OF_THE_TAB",
"tabLabel": "LABEL_USED_FOR_THE_TAB",
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232",
"pageNumber": "PAGE_NUMBER_ON_DOCUMENT",
"xPosition": "HORIZONTAL_OFFSET_OF_THE_TAB_ON_THE_PAGE"
}
],
"dateSignedTabs": [
{
"anchorString": "SEARCH_STRING(e.g., 'Signature')",
"anchorYOffset": "TAB_POSITION_AS_Y_OFFSET (e.g.,1)",
"anchorUnits": "OFFSET_UNITS (e.g., 'inches')",
"anchorXOffset": "TAB_POSITION_AS_X_OFFSET (e.g.,1)",
"anchorIgnoreIfNotPresent": "IGONRE_TAB_IF_ANCHOR_NOT_PRESENT(true/false)"
}
],
"noteTabs": [
{
"documentId": "DOCUMENT_ID_TO_MAP_THIS_TAB_TO",
"width": "200",
"height": "200",
"yPosition": "VERTICAL_OFFSET_OF_THE_TAB_ON_THE_PAGE",
"value": "VALUE_OF_THE_TAB",
"name": "TOOL_TIP_OF_THE_TAB",
"tabLabel": "LABEL_USED_FOR_THE_TAB",
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232",
"pageNumber": "1",
"xPosition": "HORIZONTAL_OFFSET_OF_THE_TAB_ON_THE_PAGE"
}
],
"signHereTabs": [
{
"anchorString": "SEARCH_STRING(e.g., 'Signature')",
"anchorYOffset": "TAB_POSITION_AS_Y_OFFSET (e.g.,1)",
"anchorUnits": "OFFSET_UNITS (e.g., 'inches')",
"anchorXOffset": "TAB_POSITION_AS_X_OFFSET (e.g.,1)",
"anchorIgnoreIfNotPresent": "IGONRE_TAB_IF_ANCHOR_NOT_PRESENT(true/false)"
}
],
"initialHereTabs": [
{
"anchorString": "SEARCH_STRING(e.g., 'Signature')",
"anchorYOffset": "TAB_POSITION_AS_Y_OFFSET (e.g.,1)",
"anchorUnits": "OFFSET_UNITS (e.g., 'inches')",
"anchorXOffset": "TAB_POSITION_AS_X_OFFSET (e.g.,1)",
"anchorIgnoreIfNotPresent": "IGONRE_TAB_IF_ANCHOR_NOT_PRESENT(true/false)"
}
]
},
"recipientId": "cf5f8273-560f-4df3-a71b-041d8ab41232",
"idCheckConfigurationName": "SMS"
}
]
}
}
/*********************/
Just to give little more context, when you are using templates the roles are defined along with templates.
When are using a document and passing it from Pega, you can provide the recipients in the create envelope request.
In general, if you pass the document to createenvelope, you cannot use template.