DataFlex / DocuSign REST API / 20. Send an Envelope Using CompositeTemplates
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "emailBlurb": "Create an envelope with a templateId",
// "emailSubject": "Template",
// "compositeTemplates": [
// {
// "serverTemplates": [
// {
// "sequence": "1",
// "templateId": "{{templateId}}"
// }
// ],
// "inlineTemplates": [
// {
// "recipients": {
// "signers": [
// {
// "email": "{{user1_email}}",
// "name": "{{user1_name}}",
// "recipientId": "2",
// "roleName": "seller",
// "tabs": {
// "signHereTabs": [
// {
// "anchorString": "test",
// "anchorUnits": "pixels",
// "anchorXOffset": "200",
// "anchorYOffset": "10"
// }
// ]
// }
// }
// ]
// },
// "sequence": "2"
// }
// ]
// }
// ],
// "status": "sent"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "emailBlurb" "Create an envelope with a templateId" To iSuccess
Get ComUpdateString Of hoJson "emailSubject" "Template" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].serverTemplates[0].sequence" "1" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].serverTemplates[0].templateId" "{{templateId}}" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].email" "{{user1_email}}" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].name" "{{user1_name}}" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].recipientId" "2" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].roleName" "seller" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorString" "test" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorUnits" "pixels" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorXOffset" "200" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].recipients.signers[0].tabs.signHereTabs[0].anchorYOffset" "10" To iSuccess
Get ComUpdateString Of hoJson "compositeTemplates[0].inlineTemplates[0].sequence" "2" To iSuccess
Get ComUpdateString Of hoJson "status" "sent" To iSuccess
// Adds the "Authorization: Bearer {{accessToken}}" header.
Set ComAuthToken Of hoHttp To "{{accessToken}}"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer {{accessToken}}"
-d '{
"emailBlurb": "Create an envelope with a templateId",
"emailSubject": "Template",
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence": "1",
"templateId": "{{templateId}}"
}
],
"inlineTemplates": [
{
"recipients": {
"signers": [
{
"email": "{{user1_email}}",
"name": "{{user1_name}}",
"recipientId": "2",
"roleName": "seller",
"tabs": {
"signHereTabs": [
{
"anchorString": "test",
"anchorUnits": "pixels",
"anchorXOffset": "200",
"anchorYOffset": "10"
}
]
}
}
]
},
"sequence": "2"
}
]
}
],
"status": "sent"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes
Postman Collection Item JSON
{
"name": "20. Send an Envelope Using CompositeTemplates",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailBlurb\": \"Create an envelope with a templateId\",\n \"emailSubject\": \"Template\",\n \"compositeTemplates\": [\n {\n \"serverTemplates\": [\n {\n \"sequence\": \"1\",\n \"templateId\": \"{{templateId}}\"\n }\n ],\n \"inlineTemplates\": [\n {\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"{{user1_email}}\",\n \"name\": \"{{user1_name}}\",\n \"recipientId\": \"2\",\n \"roleName\": \"seller\",\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"test\",\n \"anchorUnits\": \"pixels\",\n \"anchorXOffset\": \"200\",\n \"anchorYOffset\": \"10\"\n }\n ]\n }\n }\n ]\n },\n \"sequence\": \"2\"\n }\n ]\n }\n ],\n \"status\": \"sent\"\n}"
},
"url": {
"raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
"host": [
"{{baseUrl}}"
],
"path": [
"{{apiVersion}}",
"accounts",
"{{accountId}}",
"envelopes"
]
},
"description": "In this example, we will use the template we created in previous step and we will use `CompositeTemplates` to add a signer and a tab to it using `inlineTemplates`. You can see how one can create a template and keep reusing it this way."
},
"response": [
]
}
