Branded short links

Example Link Object

{
    "id": "ffs24cc5b6ee4a5gh7897b06ac2d16d4",
    "title": "The LaFerrari Supercar Convertible Is the New Best Way to Burn $1M | WIRED",
    "slashtag": "burn10M",
    "destination": "https://www.wired.com/2016/07/ferrari-laferrari-spider-convertible-photos-specs/",
    "shortUrl": "rebrand.ly/burn10M",
    "domain": {
      "id": "8f104cc5b6ee4a4ba7897b06ac2ddcfb",
      "fullName": "rebrand.ly"
    },
    "createdAt": "2016-07-13T10:54:12.000Z",
    "updatedAt": "2016-07-13T10:54:12.000Z",
    "clicks": 42,
    "lastClickAt": "2016-07-13T10:55:13.000Z",
    "favourite": false
  }

Link Object

Main properties of a Link object are:

Property	Type	Description
id	string	Unique identifier associated with the branded short link
title	string	A title you assign to the branded short link in order to remember what's behind it
slashtag	string	The keyword section of your branded short link
destination	string	The destination URL you want your branded short link to point to
shortUrl	string	The full branded short link URL, including domain
domain	Domain Reference object	A reference to the branded domain's resource of a branded short link
createdAt	timestamp	The UTC date/time this branded short link was created
updatedAt	timestamp	The last UTC date/time this branded short link was updated. When created, it matches createdAt

Other properties that also appear in a Link object are:

Property	Type	Description
clicks	integer	How many clicks there are on this branded short link so far
lastClickAt	timestamp	The UTC date/time this branded short link was last clicked on
favourite	boolean	Whether a link is favourited (loved) or not
forwardParameters	boolean	Whether query parameters in short URL will be forwarded to destination URL. E.g. `short.link/kw?p=1` with `forwardParameters=true` will redirect to `longurl.com/home/path?p=1`, otherwise will redirect to `longurl.com/home/path` (without query parameters)

Additional info

Every branded short link is created using a Branded Domain.
As long as a branded domain exists in your Rebrandly account and is correctly configured, all branded short links created with that domain will be active and working.

Each branded link is associated with a QR code image representing it. To download a PNG version of the QR code, just add .qr to an existing branded short link (e.g, rebrand.ly/video.qr is the QR code for rebrand.ly/video).

Deprecated properties

🚧
WARNING
We will continue to render deprecated Link properties for backward compatibility in v1

Deprecated properties you can find in a Link object are:

Property	Type	Description	Reason
linkId	string	Unique identifier associated with the branded short link	Now using `id` property
domainId	string	Unique identifier of the branded domain of the link	Now using a Domain Reference
lastClickDate	timestamp	The UTC date/time this branded short link was last clicked on	Now using `lastClickAt` property

Branded short links management

Here are some basic operations you can perform regarding Link resources:

Operation	Details
Create a new branded short link	See Creating a new link
Get branded short link details	See Getting link details
Access your branded short links collection Search for a specific branded short link	See Listing your links
Change destination ur for a branded short link Set a branded short link as favourite	See Updating a link
Delete a branded short link	See Deleting a link
Get analytics on a branded short link's incoming traffic	See Getting link details