Chilkat Online Tools

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

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("connectId","sample string 1")
success = json.UpdateString("configurationType","sample string 2")
success = json.UpdateString("urlToPublishTo","sample string 3")
success = json.UpdateString("name","sample string 4")
success = json.UpdateString("allowEnvelopePublish","sample string 5")
success = json.UpdateString("enableLog","sample string 6")
success = json.UpdateString("includeDocuments","sample string 7")
success = json.UpdateString("includeCertificateOfCompletion","sample string 8")
success = json.UpdateString("requiresAcknowledgement","sample string 9")
success = json.UpdateString("signMessageWithX509Certificate","sample string 10")
success = json.UpdateString("useSoapInterface","sample string 11")
success = json.UpdateString("includeTimeZoneInformation","sample string 12")
success = json.UpdateString("includeHMAC","sample string 13")
success = json.UpdateString("includeEnvelopeVoidReason","sample string 14")
success = json.UpdateString("includeSenderAccountasCustomField","sample string 15")
success = json.UpdateString("envelopeEvents","sample string 16")
success = json.UpdateString("recipientEvents","sample string 17")
success = json.UpdateString("userIds","sample string 18")
success = json.UpdateString("soapNamespace","sample string 19")
success = json.UpdateString("allUsers","sample string 20")
success = json.UpdateString("includeCertSoapHeader","sample string 21")
success = json.UpdateString("includeDocumentFields","sample string 22")

' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/json"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbRequestBody = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)

' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/connect",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)


outFile.Close

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