Chilkat Online Tools

phpExt / DocuSign REST API / Update Consumer Disclosure.

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

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

// {
//   "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"
// }

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

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

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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}}"
        },
        {
          "key": "langCode",
          "value": "{{langCode}}"
        }
      ]
    }
  },
  "response": [
  ]
}