Chilkat Online Tools

unicodeCpp / DocuSign REST API / Updates custom tab information.

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

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

    CkHttpW http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "font": "sample string 1",
    //   "bold": "sample string 2",
    //   "italic": "sample string 3",
    //   "underline": "sample string 4",
    //   "fontColor": "sample string 5",
    //   "fontSize": "sample string 6",
    //   "anchor": "sample string 7",
    //   "anchorXOffset": "sample string 8",
    //   "anchorYOffset": "sample string 9",
    //   "anchorUnits": "sample string 10",
    //   "anchorIgnoreIfNotPresent": "sample string 11",
    //   "anchorMatchWholeWord": "sample string 12",
    //   "anchorCaseSensitive": "sample string 13",
    //   "anchorHorizontalAlignment": "sample string 14",
    //   "paymentItemCode": "sample string 15",
    //   "paymentItemDescription": "sample string 16",
    //   "paymentItemName": "sample string 17",
    //   "height": "sample string 18",
    //   "width": "sample string 19",
    //   "customTabId": "sample string 20",
    //   "initialValue": "sample string 21",
    //   "includedInEmail": "sample string 22",
    //   "disableAutoSize": "sample string 23",
    //   "concealValueOnDocument": "sample string 24",
    //   "locked": "sample string 25",
    //   "required": "sample string 26",
    //   "shared": "sample string 27",
    //   "collaborative": "sample string 28",
    //   "requireInitialOnSharedChange": "sample string 29",
    //   "requireAll": "sample string 30",
    //   "items": [
    //     "sample string 1"
    //   ],
    //   "tabLabel": "sample string 31",
    //   "maximumLength": "sample string 32",
    //   "scaleValue": "sample string 33",
    //   "name": "sample string 34",
    //   "type": "sample string 35",
    //   "validationMessage": "sample string 36",
    //   "validationPattern": "sample string 37",
    //   "lastModifiedByUserId": "sample string 38",
    //   "lastModifiedByDisplayName": "sample string 39",
    //   "lastModified": "sample string 40",
    //   "createdByUserId": "sample string 41",
    //   "createdByDisplayName": "sample string 42",
    //   "editable": "sample string 43",
    //   "mergeField": {
    //     "configurationType": "sample string 1",
    //     "path": "sample string 2",
    //     "writeBack": "sample string 3",
    //     "allowSenderToEdit": "sample string 4",
    //     "row": "sample string 5"
    //   },
    //   "stampType": "sample string 44",
    //   "selected": "sample string 45"
    // }

    CkJsonObjectW json;
    json.UpdateString(L"font",L"sample string 1");
    json.UpdateString(L"bold",L"sample string 2");
    json.UpdateString(L"italic",L"sample string 3");
    json.UpdateString(L"underline",L"sample string 4");
    json.UpdateString(L"fontColor",L"sample string 5");
    json.UpdateString(L"fontSize",L"sample string 6");
    json.UpdateString(L"anchor",L"sample string 7");
    json.UpdateString(L"anchorXOffset",L"sample string 8");
    json.UpdateString(L"anchorYOffset",L"sample string 9");
    json.UpdateString(L"anchorUnits",L"sample string 10");
    json.UpdateString(L"anchorIgnoreIfNotPresent",L"sample string 11");
    json.UpdateString(L"anchorMatchWholeWord",L"sample string 12");
    json.UpdateString(L"anchorCaseSensitive",L"sample string 13");
    json.UpdateString(L"anchorHorizontalAlignment",L"sample string 14");
    json.UpdateString(L"paymentItemCode",L"sample string 15");
    json.UpdateString(L"paymentItemDescription",L"sample string 16");
    json.UpdateString(L"paymentItemName",L"sample string 17");
    json.UpdateString(L"height",L"sample string 18");
    json.UpdateString(L"width",L"sample string 19");
    json.UpdateString(L"customTabId",L"sample string 20");
    json.UpdateString(L"initialValue",L"sample string 21");
    json.UpdateString(L"includedInEmail",L"sample string 22");
    json.UpdateString(L"disableAutoSize",L"sample string 23");
    json.UpdateString(L"concealValueOnDocument",L"sample string 24");
    json.UpdateString(L"locked",L"sample string 25");
    json.UpdateString(L"required",L"sample string 26");
    json.UpdateString(L"shared",L"sample string 27");
    json.UpdateString(L"collaborative",L"sample string 28");
    json.UpdateString(L"requireInitialOnSharedChange",L"sample string 29");
    json.UpdateString(L"requireAll",L"sample string 30");
    json.UpdateString(L"items[0]",L"sample string 1");
    json.UpdateString(L"tabLabel",L"sample string 31");
    json.UpdateString(L"maximumLength",L"sample string 32");
    json.UpdateString(L"scaleValue",L"sample string 33");
    json.UpdateString(L"name",L"sample string 34");
    json.UpdateString(L"type",L"sample string 35");
    json.UpdateString(L"validationMessage",L"sample string 36");
    json.UpdateString(L"validationPattern",L"sample string 37");
    json.UpdateString(L"lastModifiedByUserId",L"sample string 38");
    json.UpdateString(L"lastModifiedByDisplayName",L"sample string 39");
    json.UpdateString(L"lastModified",L"sample string 40");
    json.UpdateString(L"createdByUserId",L"sample string 41");
    json.UpdateString(L"createdByDisplayName",L"sample string 42");
    json.UpdateString(L"editable",L"sample string 43");
    json.UpdateString(L"mergeField.configurationType",L"sample string 1");
    json.UpdateString(L"mergeField.path",L"sample string 2");
    json.UpdateString(L"mergeField.writeBack",L"sample string 3");
    json.UpdateString(L"mergeField.allowSenderToEdit",L"sample string 4");
    json.UpdateString(L"mergeField.row",L"sample string 5");
    json.UpdateString(L"stampType",L"sample string 44");
    json.UpdateString(L"selected",L"sample string 45");

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

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"%d\n",resp->get_StatusCode());
    wprintf(L"%s\n",resp->bodyStr());
    delete resp;
    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "font": "sample string 1",
  "bold": "sample string 2",
  "italic": "sample string 3",
  "underline": "sample string 4",
  "fontColor": "sample string 5",
  "fontSize": "sample string 6",
  "anchor": "sample string 7",
  "anchorXOffset": "sample string 8",
  "anchorYOffset": "sample string 9",
  "anchorUnits": "sample string 10",
  "anchorIgnoreIfNotPresent": "sample string 11",
  "anchorMatchWholeWord": "sample string 12",
  "anchorCaseSensitive": "sample string 13",
  "anchorHorizontalAlignment": "sample string 14",
  "paymentItemCode": "sample string 15",
  "paymentItemDescription": "sample string 16",
  "paymentItemName": "sample string 17",
  "height": "sample string 18",
  "width": "sample string 19",
  "customTabId": "sample string 20",
  "initialValue": "sample string 21",
  "includedInEmail": "sample string 22",
  "disableAutoSize": "sample string 23",
  "concealValueOnDocument": "sample string 24",
  "locked": "sample string 25",
  "required": "sample string 26",
  "shared": "sample string 27",
  "collaborative": "sample string 28",
  "requireInitialOnSharedChange": "sample string 29",
  "requireAll": "sample string 30",
  "items": [
    "sample string 1"
  ],
  "tabLabel": "sample string 31",
  "maximumLength": "sample string 32",
  "scaleValue": "sample string 33",
  "name": "sample string 34",
  "type": "sample string 35",
  "validationMessage": "sample string 36",
  "validationPattern": "sample string 37",
  "lastModifiedByUserId": "sample string 38",
  "lastModifiedByDisplayName": "sample string 39",
  "lastModified": "sample string 40",
  "createdByUserId": "sample string 41",
  "createdByDisplayName": "sample string 42",
  "editable": "sample string 43",
  "mergeField": {
    "configurationType": "sample string 1",
    "path": "sample string 2",
    "writeBack": "sample string 3",
    "allowSenderToEdit": "sample string 4",
    "row": "sample string 5"
  },
  "stampType": "sample string 44",
  "selected": "sample string 45"
}'
https://domain.com/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}

Postman Collection Item JSON

{
  "name": "Updates custom tab information.\n\n",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"font\": \"sample string 1\",\n  \"bold\": \"sample string 2\",\n  \"italic\": \"sample string 3\",\n  \"underline\": \"sample string 4\",\n  \"fontColor\": \"sample string 5\",\n  \"fontSize\": \"sample string 6\",\n  \"anchor\": \"sample string 7\",\n  \"anchorXOffset\": \"sample string 8\",\n  \"anchorYOffset\": \"sample string 9\",\n  \"anchorUnits\": \"sample string 10\",\n  \"anchorIgnoreIfNotPresent\": \"sample string 11\",\n  \"anchorMatchWholeWord\": \"sample string 12\",\n  \"anchorCaseSensitive\": \"sample string 13\",\n  \"anchorHorizontalAlignment\": \"sample string 14\",\n  \"paymentItemCode\": \"sample string 15\",\n  \"paymentItemDescription\": \"sample string 16\",\n  \"paymentItemName\": \"sample string 17\",\n  \"height\": \"sample string 18\",\n  \"width\": \"sample string 19\",\n  \"customTabId\": \"sample string 20\",\n  \"initialValue\": \"sample string 21\",\n  \"includedInEmail\": \"sample string 22\",\n  \"disableAutoSize\": \"sample string 23\",\n  \"concealValueOnDocument\": \"sample string 24\",\n  \"locked\": \"sample string 25\",\n  \"required\": \"sample string 26\",\n  \"shared\": \"sample string 27\",\n  \"collaborative\": \"sample string 28\",\n  \"requireInitialOnSharedChange\": \"sample string 29\",\n  \"requireAll\": \"sample string 30\",\n  \"items\": [\n    \"sample string 1\"\n  ],\n  \"tabLabel\": \"sample string 31\",\n  \"maximumLength\": \"sample string 32\",\n  \"scaleValue\": \"sample string 33\",\n  \"name\": \"sample string 34\",\n  \"type\": \"sample string 35\",\n  \"validationMessage\": \"sample string 36\",\n  \"validationPattern\": \"sample string 37\",\n  \"lastModifiedByUserId\": \"sample string 38\",\n  \"lastModifiedByDisplayName\": \"sample string 39\",\n  \"lastModified\": \"sample string 40\",\n  \"createdByUserId\": \"sample string 41\",\n  \"createdByDisplayName\": \"sample string 42\",\n  \"editable\": \"sample string 43\",\n  \"mergeField\": {\n    \"configurationType\": \"sample string 1\",\n    \"path\": \"sample string 2\",\n    \"writeBack\": \"sample string 3\",\n    \"allowSenderToEdit\": \"sample string 4\",\n    \"row\": \"sample string 5\"\n  },\n  \"stampType\": \"sample string 44\",\n  \"selected\": \"sample string 45\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "tab_definitions",
        "{{customTabId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "customTabId",
          "value": "{{customTabId}}"
        }
      ]
    },
    "description": "Updates the information in a custom tab for the specified account."
  },
  "response": [
  ]
}