Create Quicklink

Creates a quicklink. The server assigns id.

POST /api/quicklinks

Create Quicklink

cURL

curl --request POST \
  --url https://api.cludo.com/api/quicklinks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "websiteid": 123,
  "terms": [
    {
      "name": "<string>"
    }
  ]
}
'

201

{
  "url": "<string>",
  "websiteid": 123,
  "id": 123,
  "terms": [
    {
      "name": "<string>"
    }
  ],
  "brokenLinksFoundAt": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Body

application/json

Quicklink payload without id (server assigns id).

url · string · required

Destination URL the user is sent to when they select this quicklink.

websiteid · integer · required

Search engine ID this quicklink belongs to.

terms · object[]

Trigger phrases that should suggest this quicklink in autocomplete.

Show child attributes

Response

201

application/json

Quicklink created successfully.

url · string · required

Destination when the user selects this quicklink.

websiteid · integer · required

Engine this quicklink belongs to.

id · integer

Quicklink ID (assigned by server on create).

terms · object[]

All trigger phrases for this shortcut.

Show child attributes

brokenLinksFoundAt · string | null

Managed by the Cludo backend; informational only.