Links API Overview

What is the ClearSlide Links API?

The Links API allows you to create a unique ClearSlide traceable link for a target content item. This link is unique and will allow you to make subsequent API requests for the associated engagement insights.

🚧

Prerequisites

When you complete Prerequisites in ClearSlide APIs section, you will have an Authorization Token to test against our API.

How to generate complete Links API request code?

You can generate a complete functional request code snippet for the tech stack of your choice.

You can interactively add Headers and Query parameters (including filters and sorting) into the form. The documentation tool updates API request code accordingly.

Developers can copy and paste the auto-generated API request code into your project.

How do I test the Links API request code?

Here are a few options:

• Try it out allows you to trigger a request and view JSON results immediately
• Copy the request code snippet into your project. Trigger the request and parse the response to view the results in a JSON format

Sample Request Code

Our reference documentation auto-generates request code for Curl, Node, Ruby, Javascript, Python.

curl --request POST \
  --url https://platform.clearslide.com/v2/links \
  --header 'authorization: Bearer a61766c5-3e55-42f8-ae97-9239105f5391' \
  --data '{"data":{"attributes":{"presentationIds":["L5339S7JZFCJXT3UFQGK"],"sendViewAlerts":"true","userId":"E36J6TFX7HF2GPJNSDT8","internalPitch":"false","company":{"companyName":"company1","companyCrmId":"companyCrmId1","companyCrmType":"Account"},"recipientName":"recipientName1","downloadOption":{"enabled":"true","linkLocation":"Bottom","downloadOriginalFormat":"true"},"expiration":{"enabled":"true"},"allowViewerFeedback":"true"},"type":"links"}}'

Sample JSON Response

[
  {
    "type": "links",
    "id": "JHHFHLGJ77079709089",
    "attributes": {
      "viewerLink": "https://www.clearslide.com/view/mail?iID=SftknFmTCM5gpBN3hvq4",
      "previewLink": "https://www.clearslide.com/manage/email/preview/noheaders?userVID=LY26EBY5RAWVNYCQ7MXR&iID=SftknFmTCM5gpBN3hvq4"
    }
  }
]