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>"
]
}
'import requests
url = "https://api.cludo.com/api/rankings/{rankingId}"
payload = {
"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>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.cludo.com/api/rankings/{rankingId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.cludo.com/api/rankings/{rankingId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
]
}{
"viewModel.pages[0]": [
"The Url field is required."
]
}{
"message": "unauthorized"
}{
"message": "<string>"
}{
"status": "InternalServerError",
"code": 500,
"messages": [
"Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}Update Ranking
Replaces a ranking. The ranking id is taken from the URL path.
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>"
]
}
'import requests
url = "https://api.cludo.com/api/rankings/{rankingId}"
payload = {
"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>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.cludo.com/api/rankings/{rankingId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>']
})
};
fetch('https://api.cludo.com/api/rankings/{rankingId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
]
}{
"viewModel.pages[0]": [
"The Url field is required."
]
}{
"message": "unauthorized"
}{
"message": "<string>"
}{
"status": "InternalServerError",
"code": 500,
"messages": [
"Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}Authorizations
Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.
Path Parameters
Numeric id of an existing ranking rule set.
Body
Ranking update payload. The ranking id is taken from the URL path; any id in the body is ignored.
Display name for the ranking set.
Search engine ID this ranking belongs to.
Replace the ranking's full page list with this array. Pages not included are removed.
Show child attributes
Show child attributes
Replace the ranking's full trigger term list with this array. Terms not included are removed.
Show child attributes
Show child attributes
Audience targeting configuration. Omit the field entirely (or send null) when the ranking is not audience-targeted.
Response
Ranking updated successfully.
Label for this ranking group in the dashboard.
Search engine ID.
Ranking ID (assigned by server on create).
URLs and weights for pinned or boosted results.
Show child attributes
Show child attributes
Terms that activate this ranking configuration.
Show child attributes
Show child attributes
Managed by the Cludo backend; informational only.
Audience targeting configuration. Omit the field entirely (or send null) when the ranking is not audience-targeted.
Was this page helpful?

