Chilkat Online Tools

SQL Server / DocuSign REST API / Updates custom tab information.

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

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

    -- Adds the "Authorization: Bearer {{accessToken}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/v2.1/accounts/{{accountId}}/tab_definitions/{{customTabId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

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