Chilkat Online Tools

TCL / DocuSign REST API / Provides a URL to start a shared recipient view of the Envelope UI

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.

# {
#   "clientUserId": "sample string 1",
#   "userId": "sample string 2",
#   "userName": "sample string 3",
#   "email": "sample string 4",
#   "recipientId": "sample string 5",
#   "returnUrl": "sample string 6",
#   "pingUrl": "sample string 7",
#   "pingFrequency": "sample string 8",
#   "authenticationMethod": "sample string 9",
#   "assertionId": "sample string 10",
#   "authenticationInstant": "sample string 11",
#   "securityDomain": "sample string 12",
#   "xFrameOptions": "sample string 13",
#   "xFrameOptionsAllowFromUrl": "sample string 14",
#   "frameAncestors": [
#     "sample string 1"
#   ],
#   "messageOrigins": [
#     "sample string 1"
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "clientUserId" "sample string 1"
CkJsonObject_UpdateString $json "userId" "sample string 2"
CkJsonObject_UpdateString $json "userName" "sample string 3"
CkJsonObject_UpdateString $json "email" "sample string 4"
CkJsonObject_UpdateString $json "recipientId" "sample string 5"
CkJsonObject_UpdateString $json "returnUrl" "sample string 6"
CkJsonObject_UpdateString $json "pingUrl" "sample string 7"
CkJsonObject_UpdateString $json "pingFrequency" "sample string 8"
CkJsonObject_UpdateString $json "authenticationMethod" "sample string 9"
CkJsonObject_UpdateString $json "assertionId" "sample string 10"
CkJsonObject_UpdateString $json "authenticationInstant" "sample string 11"
CkJsonObject_UpdateString $json "securityDomain" "sample string 12"
CkJsonObject_UpdateString $json "xFrameOptions" "sample string 13"
CkJsonObject_UpdateString $json "xFrameOptionsAllowFromUrl" "sample string 14"
CkJsonObject_UpdateString $json "frameAncestors[0]" "sample string 1"
CkJsonObject_UpdateString $json "messageOrigins[0]" "sample string 1"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared" "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 "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "clientUserId": "sample string 1",
  "userId": "sample string 2",
  "userName": "sample string 3",
  "email": "sample string 4",
  "recipientId": "sample string 5",
  "returnUrl": "sample string 6",
  "pingUrl": "sample string 7",
  "pingFrequency": "sample string 8",
  "authenticationMethod": "sample string 9",
  "assertionId": "sample string 10",
  "authenticationInstant": "sample string 11",
  "securityDomain": "sample string 12",
  "xFrameOptions": "sample string 13",
  "xFrameOptionsAllowFromUrl": "sample string 14",
  "frameAncestors": [
    "sample string 1"
  ],
  "messageOrigins": [
    "sample string 1"
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared

Postman Collection Item JSON

{
  "name": "Provides a URL to start a shared recipient view of the Envelope UI",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"clientUserId\": \"sample string 1\",\n  \"userId\": \"sample string 2\",\n  \"userName\": \"sample string 3\",\n  \"email\": \"sample string 4\",\n  \"recipientId\": \"sample string 5\",\n  \"returnUrl\": \"sample string 6\",\n  \"pingUrl\": \"sample string 7\",\n  \"pingFrequency\": \"sample string 8\",\n  \"authenticationMethod\": \"sample string 9\",\n  \"assertionId\": \"sample string 10\",\n  \"authenticationInstant\": \"sample string 11\",\n  \"securityDomain\": \"sample string 12\",\n  \"xFrameOptions\": \"sample string 13\",\n  \"xFrameOptionsAllowFromUrl\": \"sample string 14\",\n  \"frameAncestors\": [\n    \"sample string 1\"\n  ],\n  \"messageOrigins\": [\n    \"sample string 1\"\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "shared"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}