Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "documents": [
' {
' "documentBase64": "{{documentBase64}}",
' "documentId": "123",
' "fileExtension": "pdf",
' "name": "document"
' }
' ],
' "emailSubject": "Simple Signing Example",
' "recipients": {
' "signers": [
' {
' "email": "{{email}}",
' "name": "{{name}}",
' "recipientId": "{{recipientId}}"
' }
' ]
' },
' "status": "created"
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("documents[0].documentBase64","{{documentBase64}}")
json.UpdateString("documents[0].documentId","123")
json.UpdateString("documents[0].fileExtension","pdf")
json.UpdateString("documents[0].name","document")
json.UpdateString("emailSubject","Simple Signing Example")
json.UpdateString("recipients.signers[0].email","{{email}}")
json.UpdateString("recipients.signers[0].name","{{name}}")
json.UpdateString("recipients.signers[0].recipientId","{{recipientId}}")
json.UpdateString("status","created")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"documents": [
{
"documentBase64": {{document}},
"documentId": "123",
"fileExtension": "pdf",
"name": "document"
}
],
"emailSubject": "Simple Signing Example",
"recipients": {
"signers": [
{
"email": {{user1}},
"name": {{user1_name}},
"recipientId": "{{recipientId}}"
}
]
},
"status": "created"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes
Postman Collection Item JSON
{
"name": "2. Create Envelope in Draft Stage",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"var envelopeId = jsonData.envelopeId;",
"postman.setEnvironmentVariable(\"envelopeId_draft\", envelopeId); ",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{accessToken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"documents\": [\n {\n \"documentBase64\": {{document}},\n \"documentId\": \"123\",\n \"fileExtension\": \"pdf\",\n \"name\": \"document\"\n }\n ],\n \"emailSubject\": \"Simple Signing Example\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": {{user1}},\n \"name\": {{user1_name}},\n \"recipientId\": \"{{recipientId}}\"\n }\n ]\n },\n \"status\": \"created\"\n}"
},
"url": {
"raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
"host": [
"{{baseUrl}}"
],
"path": [
"{{apiVersion}}",
"accounts",
"{{accountId}}",
"envelopes"
]
},
"description": "In this example, we are creating an envelope similar to the previous step. However, we're keeping it in `draft` stage so can continue to make changes to it. If the status was set to `sent` the envelope would be sent to users."
},
"response": [
]
}