---
title: "Toggle Link Favourite"
method: POST
path: "/links/{link_id}/favourite"
tags: ["Links"]
---

# Toggle Link Favourite

`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`

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.

## Path parameters

- `link_id` string, required

## Headers

- `Workspace` string
- `apikey` string, required

## Request body

- object
  - `favourite` boolean: Set favourite status

## Response `200`

Favourite status updated

- Link
  - `id` string, required: Link public ID (link_public_id)
  - `title` string: Human-readable title for the link
  - `slashtag` string, required: URL path component
  - `destination` string, uri, required: Target URL where the link redirects
  - `shortUrl` string, required: Complete short URL (domain + slashtag)
  - `domainId` string: Public ID of the domain used
  - `domainName` string: Full domain name
  - `domain` object: Domain object with details
    - `id` string
    - `ref` string
    - `fullName` string
    - `sharing` object
  - `clicks` integer: Number of clicks on the link
  - `createdAt` string, date-time, required: Timestamp when link was created
  - `updatedAt` string, date-time, required: Timestamp when link was last updated
  - `status` 'active' | 'deleted' | 'blocked', required: Link status
  - `description` string: Link description (only if links.notes feature is enabled)
  - `workspace` object: Workspace information
    - `id` string: Workspace public ID
  - `https` boolean: Whether the link supports HTTPS

## Other responses

- `403`: Forbidden - Insufficient permissions
- `404`: Resource not found

---

[API](https://skmtc.dev/rebrandly/apis/rebrandly-api.md) - [All operations](https://skmtc.dev/rebrandly/apis/rebrandly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rebrandly/apis/rebrandly-api/revisions/b098bf9fb684?raw)