Chilkat Online Tools

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

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("recipient","{{recipient_email}}")
success = json.UpdateInt("lifetime",900)

http.SetRequestHeader "Authorization","API-Key {{api_key}}"
http.SetRequestHeader "Content-Type","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.pandadoc.com/public/v1/documents/{{document_id}}/session","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

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