Chilkat Online Tools

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

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

    // 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 = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"connectId",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"configurationType",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"urlToPublishTo",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"name",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"allowEnvelopePublish",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"enableLog",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"includeDocuments",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"includeCertificateOfCompletion",L"sample string 8");
    CkJsonObjectW_UpdateString(json,L"requiresAcknowledgement",L"sample string 9");
    CkJsonObjectW_UpdateString(json,L"signMessageWithX509Certificate",L"sample string 10");
    CkJsonObjectW_UpdateString(json,L"useSoapInterface",L"sample string 11");
    CkJsonObjectW_UpdateString(json,L"includeTimeZoneInformation",L"sample string 12");
    CkJsonObjectW_UpdateString(json,L"includeHMAC",L"sample string 13");
    CkJsonObjectW_UpdateString(json,L"includeEnvelopeVoidReason",L"sample string 14");
    CkJsonObjectW_UpdateString(json,L"includeSenderAccountasCustomField",L"sample string 15");
    CkJsonObjectW_UpdateString(json,L"envelopeEvents",L"sample string 16");
    CkJsonObjectW_UpdateString(json,L"recipientEvents",L"sample string 17");
    CkJsonObjectW_UpdateString(json,L"userIds",L"sample string 18");
    CkJsonObjectW_UpdateString(json,L"soapNamespace",L"sample string 19");
    CkJsonObjectW_UpdateString(json,L"allUsers",L"sample string 20");
    CkJsonObjectW_UpdateString(json,L"includeCertSoapHeader",L"sample string 21");
    CkJsonObjectW_UpdateString(json,L"includeDocumentFields",L"sample string 22");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttpW_putAuthToken(http,L"{{accessToken}}");
    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/connect",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);

    }

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