Chilkat Online Tools

TCL / DocuSign eSignature REST API / 14. Created Embedded View

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "returnUrl": "http://httpbin.org/get",
#   "authenticationMethod": "none",
#   "email": "{{email}}",
#   "userName": "{{userName}}"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "returnUrl" "http://httpbin.org/get"
CkJsonObject_UpdateString $json "authenticationMethod" "none"
CkJsonObject_UpdateString $json "email" "{{email}}"
CkJsonObject_UpdateString $json "userName" "{{userName}}"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "returnUrl": "http://httpbin.org/get",
    "authenticationMethod": "none",
    "email": {{user1}},
    "userName": {{user1_name}}
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview

Postman Collection Item JSON

{
  "name": "14. Created Embedded View",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"returnUrl\": \"http://httpbin.org/get\",\n    \"authenticationMethod\": \"none\",\n    \"email\": {{user1}},\n    \"userName\": {{user1_name}}\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId_draft}}",
        "views",
        "recipient_preview"
      ]
    },
    "description": "In this example, we will create an embedded preview of what our recipients see when the envelope is sent out to them."
  },
  "response": [
  ]
}