Personalised Short Links API

Personalised Short Links API

To use the API, you must first create an API token in the Settings area and use this token with API requests.

The Short Links API endpoint will return a personalised short link from the input parameters.

The returned link will automatically redirect to the final destination page, pushing through personalisation to the web page, without using personalised data in the URL.

Additionally the Short Link will have personalised Open Graph tag data embedded in it, ensuring wherever the link is shared, a personalised preview will be shown.

Base API URL:

https://app.hyperise.io/api/v1/regular/short-links?api_token=[your token]

POST Input:

The API will provide a JSON output:

{

   "id": 10,

   "link_hash": "vF7nG3zNa",

   "link": "https://link.hyperise.com/igdUIMUZJ",

   "scenario": 0,

   "data_source_id": null,

   "image_template_id": 218291,

   "query_params": {

       "first_name": "Tim",

       "website": "apple.com",

       "business_name": "Apple"

   },

   "url": "https://example.com",

   "title": "Hi {{first_name}} great to meet you",

   "desc": "Hi {{first_name}} great to meet you and {{business_name}}",

   "user_id": 3,

   "team_id": 2,

   "created_at": "2021-03-29 13:00:28",

   "updated_at": "2021-03-29 13:00:28"

}

Test API input:

API Returns URL:    https://link.hyperise.com/igdUIMUZJ

In LinkedIn message, it looks like this:

Custom Link Domain

To enable the short link domain, you must also setup a custom Link domain in your Hyperise account.

For further details, checkout the Short Link Domain Setup Guide. 

Discover other Hyperise APIs:

1. User Authentication - Authorise the API token.

2. List Image Templates - List all active Image templates for the authorised user.

3. Image Views - List the most recent personalised views for selected image.

4. Business Data - Add/Update/View prospect data for images to use.

5. Data Enrichment - provides enriched data from an email input.