Chilkat Online Tools

unicodeCpp / DocuSign eSignature REST API / Update Consumer Disclosure.

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

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

    CkHttpW 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.

    // {
    //   "companyName": "sample string 1",
    //   "companyPhone": "sample string 2",
    //   "withdrawEmail": "sample string 3",
    //   "withdrawByEmail": "sample string 4",
    //   "withdrawByPhone": "sample string 5",
    //   "withdrawByMail": "sample string 6",
    //   "withdrawAddressLine1": "sample string 7",
    //   "withdrawAddressLine2": "sample string 8",
    //   "withdrawCity": "sample string 9",
    //   "withdrawState": "sample string 10",
    //   "withdrawPostalCode": "sample string 11",
    //   "withdrawConsequences": "sample string 12",
    //   "withdrawOther": "sample string 13",
    //   "withdrawPhone": "sample string 14",
    //   "changeEmail": "sample string 15",
    //   "changeEmailOther": "sample string 16",
    //   "copyCostPerPage": "sample string 17",
    //   "copyRequestEmail": "sample string 18",
    //   "copyFeeCollectionMethod": "sample string 19",
    //   "custom": "sample string 20",
    //   "pdfId": "sample string 21",
    //   "enableEsign": "sample string 22",
    //   "useBrand": "sample string 23",
    //   "esignAgreement": "sample string 24",
    //   "esignText": "sample string 25",
    //   "allowCDWithdraw": "sample string 26",
    //   "mustAgreeToEsign": "sample string 27",
    //   "useConsumerDisclosureWithinAccount": "sample string 28"
    // }

    CkJsonObjectW json;
    json.UpdateString(L"companyName",L"sample string 1");
    json.UpdateString(L"companyPhone",L"sample string 2");
    json.UpdateString(L"withdrawEmail",L"sample string 3");
    json.UpdateString(L"withdrawByEmail",L"sample string 4");
    json.UpdateString(L"withdrawByPhone",L"sample string 5");
    json.UpdateString(L"withdrawByMail",L"sample string 6");
    json.UpdateString(L"withdrawAddressLine1",L"sample string 7");
    json.UpdateString(L"withdrawAddressLine2",L"sample string 8");
    json.UpdateString(L"withdrawCity",L"sample string 9");
    json.UpdateString(L"withdrawState",L"sample string 10");
    json.UpdateString(L"withdrawPostalCode",L"sample string 11");
    json.UpdateString(L"withdrawConsequences",L"sample string 12");
    json.UpdateString(L"withdrawOther",L"sample string 13");
    json.UpdateString(L"withdrawPhone",L"sample string 14");
    json.UpdateString(L"changeEmail",L"sample string 15");
    json.UpdateString(L"changeEmailOther",L"sample string 16");
    json.UpdateString(L"copyCostPerPage",L"sample string 17");
    json.UpdateString(L"copyRequestEmail",L"sample string 18");
    json.UpdateString(L"copyFeeCollectionMethod",L"sample string 19");
    json.UpdateString(L"custom",L"sample string 20");
    json.UpdateString(L"pdfId",L"sample string 21");
    json.UpdateString(L"enableEsign",L"sample string 22");
    json.UpdateString(L"useBrand",L"sample string 23");
    json.UpdateString(L"esignAgreement",L"sample string 24");
    json.UpdateString(L"esignText",L"sample string 25");
    json.UpdateString(L"allowCDWithdraw",L"sample string 26");
    json.UpdateString(L"mustAgreeToEsign",L"sample string 27");
    json.UpdateString(L"useConsumerDisclosureWithinAccount",L"sample string 28");

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

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"%d\n",resp->get_StatusCode());
    wprintf(L"%s\n",resp->bodyStr());
    delete resp;
    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "companyName": "sample string 1",
  "companyPhone": "sample string 2",
  "withdrawEmail": "sample string 3",
  "withdrawByEmail": "sample string 4",
  "withdrawByPhone": "sample string 5",
  "withdrawByMail": "sample string 6",
  "withdrawAddressLine1": "sample string 7",
  "withdrawAddressLine2": "sample string 8",
  "withdrawCity": "sample string 9",
  "withdrawState": "sample string 10",
  "withdrawPostalCode": "sample string 11",
  "withdrawConsequences": "sample string 12",
  "withdrawOther": "sample string 13",
  "withdrawPhone": "sample string 14",
  "changeEmail": "sample string 15",
  "changeEmailOther": "sample string 16",
  "copyCostPerPage": "sample string 17",
  "copyRequestEmail": "sample string 18",
  "copyFeeCollectionMethod": "sample string 19",
  "custom": "sample string 20",
  "pdfId": "sample string 21",
  "enableEsign": "sample string 22",
  "useBrand": "sample string 23",
  "esignAgreement": "sample string 24",
  "esignText": "sample string 25",
  "allowCDWithdraw": "sample string 26",
  "mustAgreeToEsign": "sample string 27",
  "useConsumerDisclosureWithinAccount": "sample string 28"
}'
https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}

Postman Collection Item JSON

{
  "name": "Update Consumer Disclosure.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"companyName\": \"sample string 1\",\n  \"companyPhone\": \"sample string 2\",\n  \"withdrawEmail\": \"sample string 3\",\n  \"withdrawByEmail\": \"sample string 4\",\n  \"withdrawByPhone\": \"sample string 5\",\n  \"withdrawByMail\": \"sample string 6\",\n  \"withdrawAddressLine1\": \"sample string 7\",\n  \"withdrawAddressLine2\": \"sample string 8\",\n  \"withdrawCity\": \"sample string 9\",\n  \"withdrawState\": \"sample string 10\",\n  \"withdrawPostalCode\": \"sample string 11\",\n  \"withdrawConsequences\": \"sample string 12\",\n  \"withdrawOther\": \"sample string 13\",\n  \"withdrawPhone\": \"sample string 14\",\n  \"changeEmail\": \"sample string 15\",\n  \"changeEmailOther\": \"sample string 16\",\n  \"copyCostPerPage\": \"sample string 17\",\n  \"copyRequestEmail\": \"sample string 18\",\n  \"copyFeeCollectionMethod\": \"sample string 19\",\n  \"custom\": \"sample string 20\",\n  \"pdfId\": \"sample string 21\",\n  \"enableEsign\": \"sample string 22\",\n  \"useBrand\": \"sample string 23\",\n  \"esignAgreement\": \"sample string 24\",\n  \"esignText\": \"sample string 25\",\n  \"allowCDWithdraw\": \"sample string 26\",\n  \"mustAgreeToEsign\": \"sample string 27\",\n  \"useConsumerDisclosureWithinAccount\": \"sample string 28\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "consumer_disclosure",
        "{{langCode}}"
      ],
      "query": [
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "langCode",
          "value": "{{langCode}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}