Chilkat Online Tools

TCL / DocuSign Click API / 5. Add Tab to Envelope

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "signHereTabs": [
#     {
#       "anchorString": "test",
#       "anchorXOffset": "1",
#       "anchorYOffset": "0",
#       "anchorIgnoreIfNotPresent": "false",
#       "anchorUnits": "inches"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "signHereTabs[0].anchorString" "test"
CkJsonObject_UpdateString $json "signHereTabs[0].anchorXOffset" "1"
CkJsonObject_UpdateString $json "signHereTabs[0].anchorYOffset" "0"
CkJsonObject_UpdateString $json "signHereTabs[0].anchorIgnoreIfNotPresent" "false"
CkJsonObject_UpdateString $json "signHereTabs[0].anchorUnits" "inches"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/tabs" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp

Curl Command

curl -X POST
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
    "signHereTabs": [{
        "anchorString": "test",
        "anchorXOffset": "1",
        "anchorYOffset": "0",
        "anchorIgnoreIfNotPresent": "false",
        "anchorUnits": "inches"
    }]
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/tabs

Postman Collection Item JSON

{
  "name": "5. Add Tab to Envelope",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"signHereTabs\": [{\n        \"anchorString\": \"test\",\n        \"anchorXOffset\": \"1\",\n        \"anchorYOffset\": \"0\",\n        \"anchorIgnoreIfNotPresent\": \"false\",\n        \"anchorUnits\": \"inches\"\n    }]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/tabs",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "recipients",
        "{{recipientId}}",
        "tabs"
      ]
    },
    "description": "In this example, we will modify an evelope and add a tab to a document. This endpoint allows one to modify envelopes after they were created, which is very useful."
  },
  "response": [
  ]
}