Chilkat Online Tools

TCL / DocuSign REST API / Update Consumer Disclosure.

Back to Collection Items

load ./chilkat.dll

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

set 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"
# }

set json [new_CkJsonObject]

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

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/v2.1/accounts/{{accountId}}/consumer_disclosure/{{langCode}}?include_metadata={{include_metadata}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

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": [
  ]
}