RErebrandly
Links

Toggle Link Favourite

Mark or unmark a link as favourite for quick access.

Blocked by:

  • Link deleted (status=3)
  • Revoked workspace
  • Revoked domain

Workspace Type: Classic workspaces only.

post/links/{link_id}/favourite

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/links/{link_id}/favourite
  • Auth
    API key in header apikey

Path parameters

link_idstring required

Link public ID

Headers

Workspacestring
Example:workspace123abc

Workspace public ID

apikeystring required

API key for authentication

Request body

favouriteboolean

Set favourite status

Response

Favourite status updated

idstring required

Link public ID (link_public_id)

titlestring

Human-readable title for the link

slashtagstring required

URL path component

destinationstring uri required

Target URL where the link redirects

shortUrlstring required

Complete short URL (domain + slashtag)

domainIdstring

Public ID of the domain used

domainNamestring

Full domain name

clicksinteger

Number of clicks on the link

createdAtstring date-time required

Timestamp when link was created

updatedAtstring date-time required

Timestamp when link was last updated

status'active' | 'deleted' | 'blocked' required

Link status

descriptionstring

Link description (only if links.notes feature is enabled)

httpsboolean

Whether the link supports HTTPS

Example response

{
  "id": "abc123def456",
  "title": "My Example Link",
  "slashtag": "my-link",
  "destination": "https://example.com",
  "shortUrl": "rebrand.ly/my-link",
  "domainId": "domain123abc",
  "domainName": "rebrand.ly",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "status": "active",
  "description": "This link redirects to our example page",
  "https": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.