Chilkat Online Tools

SQL Server / DocuSign REST API / Updates envelope custom fields in a template.

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.

    -- {
    --   "password": "sample string 1",
    --   "textCustomFields": [
    --     {
    --       "fieldId": "sample string 1",
    --       "name": "sample string 2",
    --       "show": "sample string 3",
    --       "required": "sample string 4",
    --       "value": "sample string 5",
    --       "configurationType": "sample string 6"
    --     }
    --   ],
    --   "listCustomFields": [
    --     {
    --       "listItems": [
    --         "sample string 1"
    --       ],
    --       "fieldId": "sample string 1",
    --       "name": "sample string 2",
    --       "show": "sample string 3",
    --       "required": "sample string 4",
    --       "value": "sample string 5",
    --       "configurationType": "sample string 6"
    --     }
    --   ]
    -- }

    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, 'password', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].fieldId', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].name', 'sample string 2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].show', 'sample string 3'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].required', 'sample string 4'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].value', 'sample string 5'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'textCustomFields[0].configurationType', 'sample string 6'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].listItems[0]', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].fieldId', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].name', 'sample string 2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].show', 'sample string 3'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].required', 'sample string 4'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].value', 'sample string 5'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'listCustomFields[0].configurationType', 'sample string 6'

    -- 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}}/templates/{{templateId}}/custom_fields', @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 '{
  "password": "sample string 1",
  "textCustomFields": [
    {
      "fieldId": "sample string 1",
      "name": "sample string 2",
      "show": "sample string 3",
      "required": "sample string 4",
      "value": "sample string 5",
      "configurationType": "sample string 6"
    }
  ],
  "listCustomFields": [
    {
      "listItems": [
        "sample string 1"
      ],
      "fieldId": "sample string 1",
      "name": "sample string 2",
      "show": "sample string 3",
      "required": "sample string 4",
      "value": "sample string 5",
      "configurationType": "sample string 6"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/custom_fields

Postman Collection Item JSON

{
  "name": "Updates envelope custom fields in a template.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"password\": \"sample string 1\",\n  \"textCustomFields\": [\n    {\n      \"fieldId\": \"sample string 1\",\n      \"name\": \"sample string 2\",\n      \"show\": \"sample string 3\",\n      \"required\": \"sample string 4\",\n      \"value\": \"sample string 5\",\n      \"configurationType\": \"sample string 6\"\n    }\n  ],\n  \"listCustomFields\": [\n    {\n      \"listItems\": [\n        \"sample string 1\"\n      ],\n      \"fieldId\": \"sample string 1\",\n      \"name\": \"sample string 2\",\n      \"show\": \"sample string 3\",\n      \"required\": \"sample string 4\",\n      \"value\": \"sample string 5\",\n      \"configurationType\": \"sample string 6\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/custom_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "custom_fields"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "description": "Updates the custom fields in a template.\n\nEach custom field used in a template must have a unique name."
  },
  "response": [
  ]
}