Skip to main content
POST
/
knowledge
/
links
Create a new link
curl --request POST \
  --url https://api.getfernand.com/knowledge/links \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "Contact Us",
  "url": "https://piedpiper.com/contact",
  "target": "_blank",
  "position": "HEADER"
}
'
{
  "id": 123,
  "sort": 1,
  "url": "https://piedpiper.com/contact",
  "target": "_blank",
  "position": "HEADER",
  "title": "Contact Us"
}
Creates a new navigation link in the knowledge base header or footer. Links are automatically assigned a sort order based on their position among existing links. URLs are automatically prefixed with https:// if no protocol is provided. The combination of URL and position must be unique within the knowledge base.

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.

Body

application/json
​
title
string
required

Display text for the link (required).

Maximum string length: 60
Example:

"Contact Us"

​
url
string
required

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

Maximum string length: 250
Example:

"https://piedpiper.com/contact"

​
target
enum<string>
required

Link target behavior - _blank opens in new tab, _self opens in same window (required).

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

"_blank"

​
position
enum<string>
required

Where the link should be displayed (required, case-insensitive).

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

"HEADER"

Response

Link created successfully.

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"