Skip to main content
PUT
/
api
/
rankings
/
{rankingId}
Update Ranking
curl --request PUT \
  --url https://api.cludo.com/api/rankings/{rankingId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "WebsiteId": 123,
  "pages": [
    {
      "rank": 1,
      "showpage": true,
      "page": {
        "name": "<string>",
        "pageid": "<string>",
        "pageurl": "<string>",
        "searchable": true,
        "websiteid": 123
      },
      "websiteid": 123
    }
  ],
  "rankingterms": [
    {
      "name": "<string>"
    }
  ],
  "audiences": [
    "<unknown>"
  ]
}
'
{
  "name": "<string>",
  "WebsiteId": 123,
  "id": 123,
  "pages": [
    {
      "rank": 1,
      "showpage": true,
      "page": {
        "name": "<string>",
        "pageid": "<string>",
        "pageurl": "<string>",
        "searchable": true,
        "websiteid": 123
      },
      "websiteid": 123
    }
  ],
  "rankingterms": [
    {
      "name": "<string>"
    }
  ],
  "brokenLinksFoundAt": "<string>",
  "audiences": [
    "<unknown>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://cludo.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

rankingId
integer
required

Numeric id of an existing ranking rule set.

Body

application/json

Ranking update payload. The ranking id is taken from the URL path; any id in the body is ignored.

name
string
required

Display name for the ranking set.

WebsiteId
integer
required

Search engine ID this ranking belongs to.

pages
object[]

Replace the ranking's full page list with this array. Pages not included are removed.

rankingterms
object[]

Replace the ranking's full trigger term list with this array. Terms not included are removed.

audiences
any[] | null

Audience targeting configuration. Omit the field entirely (or send null) when the ranking is not audience-targeted.

Response

Ranking updated successfully.

name
string
required

Label for this ranking group in the dashboard.

WebsiteId
integer
required

Search engine ID.

id
integer

Ranking ID (assigned by server on create).

pages
object[]

URLs and weights for pinned or boosted results.

rankingterms
object[]

Terms that activate this ranking configuration.

Managed by the Cludo backend; informational only.

audiences
any[] | null

Audience targeting configuration. Omit the field entirely (or send null) when the ranking is not audience-targeted.