Chilkat Online Tools

autoit / DocuSign REST API / Updates a specified Connect configuration.

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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"
; }

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

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/connect",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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