Chilkat Online Tools

VB.NET / DocuSign eSignature REST API / Provides a URL to start a shared recipient view of the Envelope UI

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.

' {
'   "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"
'   ]
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("clientUserId","sample string 1")
json.UpdateString("userId","sample string 2")
json.UpdateString("userName","sample string 3")
json.UpdateString("email","sample string 4")
json.UpdateString("recipientId","sample string 5")
json.UpdateString("returnUrl","sample string 6")
json.UpdateString("pingUrl","sample string 7")
json.UpdateString("pingFrequency","sample string 8")
json.UpdateString("authenticationMethod","sample string 9")
json.UpdateString("assertionId","sample string 10")
json.UpdateString("authenticationInstant","sample string 11")
json.UpdateString("securityDomain","sample string 12")
json.UpdateString("xFrameOptions","sample string 13")
json.UpdateString("xFrameOptionsAllowFromUrl","sample string 14")
json.UpdateString("frameAncestors[0]","sample string 1")

' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader("Accept","application/json")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared","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 "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"
  ]
}'
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}"
    },
    "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}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}