Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

* 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')
loHttp = 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')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("connectId","sample string 1")
loJson.UpdateString("configurationType","sample string 2")
loJson.UpdateString("urlToPublishTo","sample string 3")
loJson.UpdateString("name","sample string 4")
loJson.UpdateString("allowEnvelopePublish","sample string 5")
loJson.UpdateString("enableLog","sample string 6")
loJson.UpdateString("includeDocuments","sample string 7")
loJson.UpdateString("includeCertificateOfCompletion","sample string 8")
loJson.UpdateString("requiresAcknowledgement","sample string 9")
loJson.UpdateString("signMessageWithX509Certificate","sample string 10")
loJson.UpdateString("useSoapInterface","sample string 11")
loJson.UpdateString("includeTimeZoneInformation","sample string 12")
loJson.UpdateString("includeHMAC","sample string 13")
loJson.UpdateString("includeEnvelopeVoidReason","sample string 14")
loJson.UpdateString("includeSenderAccountasCustomField","sample string 15")
loJson.UpdateString("envelopeEvents","sample string 16")
loJson.UpdateString("recipientEvents","sample string 17")
loJson.UpdateString("userIds","sample string 18")
loJson.UpdateString("soapNamespace","sample string 19")
loJson.UpdateString("allUsers","sample string 20")
loJson.UpdateString("includeCertSoapHeader","sample string 21")
loJson.UpdateString("includeDocumentFields","sample string 22")

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

loResp = loHttp.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/connect","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

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