Chilkat Online Tools

Perl / DocuSign eSignature REST API / Updates a specified Connect configuration.

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

# The following JSON is sent in the request body.

# {
#   "connectId": "sample string 1",
#   "configurationType": "sample string 2",
#   "urlToPublishTo": "sample string 3",
#   "name": "sample string 4",
#   "allowEnvelopePublish": "sample string 5",
#   "enableLog": "sample string 6",
#   "includeDocuments": "sample string 7",
#   "includeCertificateOfCompletion": "sample string 8",
#   "requiresAcknowledgement": "sample string 9",
#   "signMessageWithX509Certificate": "sample string 10",
#   "useSoapInterface": "sample string 11",
#   "includeTimeZoneInformation": "sample string 12",
#   "includeHMAC": "sample string 13",
#   "includeEnvelopeVoidReason": "sample string 14",
#   "includeSenderAccountasCustomField": "sample string 15",
#   "envelopeEvents": "sample string 16",
#   "recipientEvents": "sample string 17",
#   "userIds": "sample string 18",
#   "soapNamespace": "sample string 19",
#   "allUsers": "sample string 20",
#   "includeCertSoapHeader": "sample string 21",
#   "includeDocumentFields": "sample string 22"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("connectId","sample string 1");
$json->UpdateString("configurationType","sample string 2");
$json->UpdateString("urlToPublishTo","sample string 3");
$json->UpdateString("name","sample string 4");
$json->UpdateString("allowEnvelopePublish","sample string 5");
$json->UpdateString("enableLog","sample string 6");
$json->UpdateString("includeDocuments","sample string 7");
$json->UpdateString("includeCertificateOfCompletion","sample string 8");
$json->UpdateString("requiresAcknowledgement","sample string 9");
$json->UpdateString("signMessageWithX509Certificate","sample string 10");
$json->UpdateString("useSoapInterface","sample string 11");
$json->UpdateString("includeTimeZoneInformation","sample string 12");
$json->UpdateString("includeHMAC","sample string 13");
$json->UpdateString("includeEnvelopeVoidReason","sample string 14");
$json->UpdateString("includeSenderAccountasCustomField","sample string 15");
$json->UpdateString("envelopeEvents","sample string 16");
$json->UpdateString("recipientEvents","sample string 17");
$json->UpdateString("userIds","sample string 18");
$json->UpdateString("soapNamespace","sample string 19");
$json->UpdateString("allUsers","sample string 20");
$json->UpdateString("includeCertSoapHeader","sample string 21");
$json->UpdateString("includeDocumentFields","sample string 22");

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

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

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/connect",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

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

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "connectId": "sample string 1",
  "configurationType": "sample string 2",
  "urlToPublishTo": "sample string 3",
  "name": "sample string 4",
  "allowEnvelopePublish": "sample string 5",
  "enableLog": "sample string 6",
  "includeDocuments": "sample string 7",
  "includeCertificateOfCompletion": "sample string 8",
  "requiresAcknowledgement": "sample string 9",
  "signMessageWithX509Certificate": "sample string 10",
  "useSoapInterface": "sample string 11",
  "includeTimeZoneInformation": "sample string 12",
  "includeHMAC": "sample string 13",
  "includeEnvelopeVoidReason": "sample string 14",
  "includeSenderAccountasCustomField": "sample string 15",
  "envelopeEvents": "sample string 16",
  "recipientEvents": "sample string 17",
  "userIds": "sample string 18",
  "soapNamespace": "sample string 19",
  "allUsers": "sample string 20",
  "includeCertSoapHeader": "sample string 21",
  "includeDocumentFields": "sample string 22"
}'
https://domain.com/v2.1/accounts/{{accountId}}/connect

Postman Collection Item JSON

{
  "name": "Updates a specified Connect configuration.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"connectId\": \"sample string 1\",\n  \"configurationType\": \"sample string 2\",\n  \"urlToPublishTo\": \"sample string 3\",\n  \"name\": \"sample string 4\",\n  \"allowEnvelopePublish\": \"sample string 5\",\n  \"enableLog\": \"sample string 6\",\n  \"includeDocuments\": \"sample string 7\",\n  \"includeCertificateOfCompletion\": \"sample string 8\",\n  \"requiresAcknowledgement\": \"sample string 9\",\n  \"signMessageWithX509Certificate\": \"sample string 10\",\n  \"useSoapInterface\": \"sample string 11\",\n  \"includeTimeZoneInformation\": \"sample string 12\",\n  \"includeHMAC\": \"sample string 13\",\n  \"includeEnvelopeVoidReason\": \"sample string 14\",\n  \"includeSenderAccountasCustomField\": \"sample string 15\",\n  \"envelopeEvents\": \"sample string 16\",\n  \"recipientEvents\": \"sample string 17\",\n  \"userIds\": \"sample string 18\",\n  \"soapNamespace\": \"sample string 19\",\n  \"allUsers\": \"sample string 20\",\n  \"includeCertSoapHeader\": \"sample string 21\",\n  \"includeDocumentFields\": \"sample string 22\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/connect",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "connect"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Updates the specified DocuSign Connect configuration in your account.\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce."
  },
  "response": [
  ]
}