Chilkat Online Tools

lianja / DocuSign REST API / Updates document visibility for the recipients

Back to Collection Items

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

loHttp = createobject("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.

// {
//   "documentVisibility": [
//     {
//       "recipientId": "sample string 1",
//       "documentId": "sample string 2",
//       "visible": "sample string 3",
//       "rights": "sample string 4"
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("documentVisibility[0].recipientId","sample string 1")
loJson.UpdateString("documentVisibility[0].documentId","sample string 2")
loJson.UpdateString("documentVisibility[0].visible","sample string 3")
loJson.UpdateString("documentVisibility[0].rights","sample string 4")

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/document_visibility",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson
release loSbRequestBody

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "documentVisibility": [
    {
      "recipientId": "sample string 1",
      "documentId": "sample string 2",
      "visible": "sample string 3",
      "rights": "sample string 4"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/document_visibility

Postman Collection Item JSON

{
  "name": "Updates document visibility for the recipients",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documentVisibility\": [\n    {\n      \"recipientId\": \"sample string 1\",\n      \"documentId\": \"sample string 2\",\n      \"visible\": \"sample string 3\",\n      \"rights\": \"sample string 4\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/document_visibility",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "recipients",
        "{{recipientId}}",
        "document_visibility"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        },
        {
          "key": "recipientId",
          "value": "{{recipientId}}"
        }
      ]
    }
  },
  "response": [
  ]
}