Create searchable link

Create a new searchable Link

Creates a new searchable link. Searchable links appear in search results when the configured keywords are matched.

Requires authentication.

Request

POST /searchable

Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

Request Body

FieldTypeRequiredDescription
titlestringYesDisplay title shown in search results.
urlstringYesThe URL to surface in search results.
keywordsstringYesComma-separated list of keywords that trigger this link.
isExternalbooleanNoSet to true if the URL points to an external site. Defaults to false.

Example Request

{
  "title": "Contact Support",
  "url": "/support/contact",
  "keywords": "contact, support, help, customer service",
  "isExternal": false
}

Response

Returns the created searchable link object.

Body Params
string
string

The URL that should be included in the search result.

boolean

Whether the URL is internal or external. This information will also be included in the search result.

string

Comma-separated list of keywords that should trigger displaying the URL in the search result.

Headers
string
required

Makaira Instance ID

Response
200

OK

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!