Skip to main content
PATCH
/
knowledge
/
links
/
{id}
Update a link
curl --request PATCH \
  --url https://api.getfernand.com/knowledge/links/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "url": "<string>",
  "target": "_blank",
  "position": "HEADER",
  "sort": 123
}
'
{
  "id": 123,
  "sort": 1,
  "url": "https://piedpiper.com/contact",
  "target": "_blank",
  "position": "HEADER",
  "title": "Contact Us"
}
Updates link properties. When updating the sort order, provide only the ‘sort’ field with the new zero-based position - this will reorder the link within its position (HEADER or FOOTER) and adjust neighboring links automatically. When updating other fields, all link properties can be modified individually or together. URLs are automatically prefixed with https:// if no protocol is provided.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

​
id
integer
required

ID of the link to update.

Body

application/json
​
title
string

Display text for the link (optional).

Maximum string length: 60
​
url
string

Destination URL (optional, automatically prefixed with https:// if missing).

Maximum string length: 250
​
target
enum<string>

Link target behavior (optional).

Available options:
_blank,
_self
Maximum string length: 6
​
position
enum<string>

Display position (optional, case-insensitive).

Available options:
HEADER,
FOOTER
Maximum string length: 6
​
sort
integer

New sort position (zero-based, optional). When provided, only updates sort order and returns empty response.

Response

Link updated successfully. Returns empty response when only sort was updated, otherwise returns the updated link.

Navigation link combined with language-specific content. Inherits all properties from KnowledgeLink model and adds language-specific fields.

​
id
integer<int64>

Unique identifier for the link.

​
sort
integer

Sort order within the position (HEADER or FOOTER).

Example:

1

​
url
string

Destination URL for the link.

Maximum string length: 250
Example:

"https://piedpiper.com/contact"

​
target
enum<string>

Link target behavior - _blank for new tab, _self for same window.

Available options:
_blank,
_self
Maximum string length: 6
Example:

"_blank"

​
position
enum<string>

Where the link is displayed in the knowledge base.

Available options:
HEADER,
FOOTER
Maximum string length: 6
Example:

"HEADER"

​
title
string

Display text for the link shown in navigation.

Maximum string length: 250
Example:

"Contact Us"