Chilkat Online Tools

PowerBuilder / DocuSign REST API / Creates a connect configuration for the specified account.

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

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

// Adds the "Authorization: Bearer {{accessToken}}" header.
loo_Http.AuthToken = "{{accessToken}}"
loo_Http.SetRequestHeader("Accept","application/json")

loo_Resp = loo_Http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/connect","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

Curl Command

curl -X POST
	-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": "Creates a connect configuration for the specified account.",
  "request": {
    "method": "POST",
    "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": "Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide].\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal."
  },
  "response": [
  ]
}