Chilkat Online Tools

autoit / DocuSign REST API / Modifies tab settings for specified account

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "textTabsEnabled": "sample string 1",
;   "textTabsMetadata": {
;     "rights": "sample string 1",
;     "uiHint": "sample string 2",
;     "uiType": "sample string 3",
;     "uiOrder": "sample string 4",
;     "is21CFRPart11": "sample string 5",
;     "options": [
;       "sample string 1"
;     ]
;   },
;   "radioTabsEnabled": "sample string 2",
;   "radioTabsMetadata": {},
;   "checkboxTabsEnabled": "sample string 3",
;   "checkboxTabsMetadata": {},
;   "listTabsEnabled": "sample string 4",
;   "listTabsMetadata": {},
;   "approveDeclineTabsEnabled": "sample string 5",
;   "approveDeclineTabsMetadata": {},
;   "noteTabsEnabled": "sample string 6",
;   "noteTabsMetadata": {},
;   "dataFieldRegexEnabled": "sample string 7",
;   "dataFieldRegexMetadata": {},
;   "dataFieldSizeEnabled": "sample string 8",
;   "dataFieldSizeMetadata": {},
;   "tabLocationEnabled": "sample string 9",
;   "tabLocationMetadata": {},
;   "tabScaleEnabled": "sample string 10",
;   "tabScaleMetadata": {},
;   "tabLockingEnabled": "sample string 11",
;   "tabLockingMetadata": {},
;   "savingCustomTabsEnabled": "sample string 12",
;   "savingCustomTabsMetadata": {},
;   "tabTextFormattingEnabled": "sample string 13",
;   "tabTextFormattingMetadata": {},
;   "sharedCustomTabsEnabled": "sample string 14",
;   "sharedCustomTabsMetadata": {},
;   "senderToChangeTabAssignmentsEnabled": "sample string 15",
;   "senderToChangeTabAssignmentsMetadata": {},
;   "tabDataLabelEnabled": "sample string 16",
;   "tabDataLabelMetadata": {},
;   "firstLastEmailTabsEnabled": "sample string 17",
;   "firstLastEmailTabsMetadata": {},
;   "calculatedFieldsEnabled": "sample string 18",
;   "calculatedFieldsMetadata": {},
;   "allowTabOrder": "sample string 19",
;   "allowTabOrderMetadata": {}
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("textTabsEnabled","sample string 1")
$oJson.UpdateString("textTabsMetadata.rights","sample string 1")
$oJson.UpdateString("textTabsMetadata.uiHint","sample string 2")
$oJson.UpdateString("textTabsMetadata.uiType","sample string 3")
$oJson.UpdateString("textTabsMetadata.uiOrder","sample string 4")
$oJson.UpdateString("textTabsMetadata.is21CFRPart11","sample string 5")
$oJson.UpdateString("textTabsMetadata.options[0]","sample string 1")
$oJson.UpdateString("radioTabsEnabled","sample string 2")
$oJson.UpdateNewObject("radioTabsMetadata")
$oJson.UpdateString("checkboxTabsEnabled","sample string 3")
$oJson.UpdateNewObject("checkboxTabsMetadata")
$oJson.UpdateString("listTabsEnabled","sample string 4")
$oJson.UpdateNewObject("listTabsMetadata")
$oJson.UpdateString("approveDeclineTabsEnabled","sample string 5")
$oJson.UpdateNewObject("approveDeclineTabsMetadata")
$oJson.UpdateString("noteTabsEnabled","sample string 6")
$oJson.UpdateNewObject("noteTabsMetadata")
$oJson.UpdateString("dataFieldRegexEnabled","sample string 7")
$oJson.UpdateNewObject("dataFieldRegexMetadata")
$oJson.UpdateString("dataFieldSizeEnabled","sample string 8")
$oJson.UpdateNewObject("dataFieldSizeMetadata")
$oJson.UpdateString("tabLocationEnabled","sample string 9")
$oJson.UpdateNewObject("tabLocationMetadata")
$oJson.UpdateString("tabScaleEnabled","sample string 10")
$oJson.UpdateNewObject("tabScaleMetadata")
$oJson.UpdateString("tabLockingEnabled","sample string 11")
$oJson.UpdateNewObject("tabLockingMetadata")
$oJson.UpdateString("savingCustomTabsEnabled","sample string 12")
$oJson.UpdateNewObject("savingCustomTabsMetadata")
$oJson.UpdateString("tabTextFormattingEnabled","sample string 13")
$oJson.UpdateNewObject("tabTextFormattingMetadata")
$oJson.UpdateString("sharedCustomTabsEnabled","sample string 14")
$oJson.UpdateNewObject("sharedCustomTabsMetadata")
$oJson.UpdateString("senderToChangeTabAssignmentsEnabled","sample string 15")
$oJson.UpdateNewObject("senderToChangeTabAssignmentsMetadata")
$oJson.UpdateString("tabDataLabelEnabled","sample string 16")
$oJson.UpdateNewObject("tabDataLabelMetadata")
$oJson.UpdateString("firstLastEmailTabsEnabled","sample string 17")
$oJson.UpdateNewObject("firstLastEmailTabsMetadata")
$oJson.UpdateString("calculatedFieldsEnabled","sample string 18")
$oJson.UpdateNewObject("calculatedFieldsMetadata")
$oJson.UpdateString("allowTabOrder","sample string 19")
$oJson.UpdateNewObject("allowTabOrderMetadata")

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/settings/tabs",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "textTabsEnabled": "sample string 1",
  "textTabsMetadata": {
    "rights": "sample string 1",
    "uiHint": "sample string 2",
    "uiType": "sample string 3",
    "uiOrder": "sample string 4",
    "is21CFRPart11": "sample string 5",
    "options": [
      "sample string 1"
    ]
  },
  "radioTabsEnabled": "sample string 2",
  "radioTabsMetadata": {},
  "checkboxTabsEnabled": "sample string 3",
  "checkboxTabsMetadata": {},
  "listTabsEnabled": "sample string 4",
  "listTabsMetadata": {},
  "approveDeclineTabsEnabled": "sample string 5",
  "approveDeclineTabsMetadata": {},
  "noteTabsEnabled": "sample string 6",
  "noteTabsMetadata": {},
  "dataFieldRegexEnabled": "sample string 7",
  "dataFieldRegexMetadata": {},
  "dataFieldSizeEnabled": "sample string 8",
  "dataFieldSizeMetadata": {},
  "tabLocationEnabled": "sample string 9",
  "tabLocationMetadata": {},
  "tabScaleEnabled": "sample string 10",
  "tabScaleMetadata": {},
  "tabLockingEnabled": "sample string 11",
  "tabLockingMetadata": {},
  "savingCustomTabsEnabled": "sample string 12",
  "savingCustomTabsMetadata": {},
  "tabTextFormattingEnabled": "sample string 13",
  "tabTextFormattingMetadata": {},
  "sharedCustomTabsEnabled": "sample string 14",
  "sharedCustomTabsMetadata": {},
  "senderToChangeTabAssignmentsEnabled": "sample string 15",
  "senderToChangeTabAssignmentsMetadata": {},
  "tabDataLabelEnabled": "sample string 16",
  "tabDataLabelMetadata": {},
  "firstLastEmailTabsEnabled": "sample string 17",
  "firstLastEmailTabsMetadata": {},
  "calculatedFieldsEnabled": "sample string 18",
  "calculatedFieldsMetadata": {},
  "allowTabOrder": "sample string 19",
  "allowTabOrderMetadata": {}
}'
https://domain.com/v2.1/accounts/{{accountId}}/settings/tabs

Postman Collection Item JSON

{
  "name": "Modifies tab settings for specified account",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"textTabsEnabled\": \"sample string 1\",\n  \"textTabsMetadata\": {\n    \"rights\": \"sample string 1\",\n    \"uiHint\": \"sample string 2\",\n    \"uiType\": \"sample string 3\",\n    \"uiOrder\": \"sample string 4\",\n    \"is21CFRPart11\": \"sample string 5\",\n    \"options\": [\n      \"sample string 1\"\n    ]\n  },\n  \"radioTabsEnabled\": \"sample string 2\",\n  \"radioTabsMetadata\": {},\n  \"checkboxTabsEnabled\": \"sample string 3\",\n  \"checkboxTabsMetadata\": {},\n  \"listTabsEnabled\": \"sample string 4\",\n  \"listTabsMetadata\": {},\n  \"approveDeclineTabsEnabled\": \"sample string 5\",\n  \"approveDeclineTabsMetadata\": {},\n  \"noteTabsEnabled\": \"sample string 6\",\n  \"noteTabsMetadata\": {},\n  \"dataFieldRegexEnabled\": \"sample string 7\",\n  \"dataFieldRegexMetadata\": {},\n  \"dataFieldSizeEnabled\": \"sample string 8\",\n  \"dataFieldSizeMetadata\": {},\n  \"tabLocationEnabled\": \"sample string 9\",\n  \"tabLocationMetadata\": {},\n  \"tabScaleEnabled\": \"sample string 10\",\n  \"tabScaleMetadata\": {},\n  \"tabLockingEnabled\": \"sample string 11\",\n  \"tabLockingMetadata\": {},\n  \"savingCustomTabsEnabled\": \"sample string 12\",\n  \"savingCustomTabsMetadata\": {},\n  \"tabTextFormattingEnabled\": \"sample string 13\",\n  \"tabTextFormattingMetadata\": {},\n  \"sharedCustomTabsEnabled\": \"sample string 14\",\n  \"sharedCustomTabsMetadata\": {},\n  \"senderToChangeTabAssignmentsEnabled\": \"sample string 15\",\n  \"senderToChangeTabAssignmentsMetadata\": {},\n  \"tabDataLabelEnabled\": \"sample string 16\",\n  \"tabDataLabelMetadata\": {},\n  \"firstLastEmailTabsEnabled\": \"sample string 17\",\n  \"firstLastEmailTabsMetadata\": {},\n  \"calculatedFieldsEnabled\": \"sample string 18\",\n  \"calculatedFieldsMetadata\": {},\n  \"allowTabOrder\": \"sample string 19\",\n  \"allowTabOrderMetadata\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/settings/tabs",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "settings",
        "tabs"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}