Chilkat Online Tools

PureBasic / DocuSign REST API / Updates custom tab information.

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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