Chilkat Online Tools

TCL / PandaDoc API Reference / Share Document (Session ID)

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.

# {
#   "recipient": "{{recipient_email}}",
#   "lifetime": 900
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "recipient" "{{recipient_email}}"
CkJsonObject_UpdateInt $json "lifetime" 900

CkHttp_SetRequestHeader $http "Authorization" "API-Key {{api_key}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.pandadoc.com/public/v1/documents/{{document_id}}/session" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

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


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "Authorization: Bearer {{access_token}}"
	-H "Authorization: API-Key {{api_key}}"
	-H "Content-Type: application/json"
	-d '{
    "recipient": "{{recipient_email}}",
    "lifetime": 900
}'
https://api.pandadoc.com/public/v1/documents/{{document_id}}/session

Postman Collection Item JSON

{
  "name": "Share Document (Session ID)",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "if (jsonData.id !== undefined) {",
          "    postman.setEnvironmentVariable(\"session_id\", jsonData.id);",
          "}"
        ]
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{access_token}}",
        "disabled": true
      },
      {
        "key": "Authorization",
        "value": "API-Key {{api_key}}",
        "type": "text"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"recipient\": \"{{recipient_email}}\",\n    \"lifetime\": 900\n}"
    },
    "url": {
      "raw": "https://api.pandadoc.com/public/v1/documents/{{document_id}}/session",
      "protocol": "https",
      "host": [
        "api",
        "pandadoc",
        "com"
      ],
      "path": [
        "public",
        "v1",
        "documents",
        "{{document_id}}",
        "session"
      ]
    },
    "description": "For details go to [https://developers.pandadoc.com/v1/reference#link-to-a-document](https://developers.pandadoc.com/v1/reference#link-to-a-document).\n\nFor details of document sharing go to [https://developers.pandadoc.com/v1/reference#share-document](https://developers.pandadoc.com/v1/reference#share-document)."
  },
  "response": [
  ]
}