Chilkat Online Tools

C++ / DocuSign REST API / Updates document visibility for the recipients

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

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

    CkHttp http;
    bool success;

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

    // The following JSON is sent in the request body.

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

    CkJsonObject json;
    json.UpdateString("password","sample string 1");
    json.UpdateString("documentVisibility[0].recipientId","sample string 1");
    json.UpdateString("documentVisibility[0].documentId","sample string 2");
    json.UpdateString("documentVisibility[0].visible","sample string 3");
    json.UpdateString("documentVisibility[0].rights","sample string 4");

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

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients/{{recipientId}}/document_visibility",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    std::cout << resp->get_StatusCode() << "\r\n";
    std::cout << resp->bodyStr() << "\r\n";
    delete resp;
    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "password": "sample string 1",
  "documentVisibility": [
    {
      "recipientId": "sample string 1",
      "documentId": "sample string 2",
      "visible": "sample string 3",
      "rights": "sample string 4"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/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  \"password\": \"sample string 1\",\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}}/templates/{{templateId}}/recipients/{{recipientId}}/document_visibility",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "recipients",
        "{{recipientId}}",
        "document_visibility"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "recipientId",
          "value": "{{recipientId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    }
  },
  "response": [
  ]
}