Chilkat Tools

Foxpro / DocuSign REST API / Updates custom tab information.

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
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.

* {
*   "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"
* }

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

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

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

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

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

Chilkat Online Tools

Foxpro / DocuSign REST API / Updates custom tab information.

Curl Command

Postman Collection Item JSON