SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Change the link-checking schedule, brand phrases or crawl budget

PUThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/links/settings

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

schedulestring

Kept for older apps and ignored for reading: the website is read automatically on its update schedule.

brand_phrasesarray of strings

Phrases to search for as mentions, at most 5 of up to 80 characters each.

crawl_budgetinteger

Pages per crawl, within the plan cap. Send null to go back to the default.

respect_robotsboolean

Obey robots.txt when crawling.

Response

Response Body

schedulestringoff, weekly or monthly automatic reads of the website.
last_run_atstring | nullLast scheduled run.
brand_phrasesarray of stringsPhrases searched for as mentions.
suggested_phrasesarray of stringsPhrases derived from the name and domain.
crawl_budgetinteger | nullPages per crawl override, null for the default of 500.
respect_robotsbooleanWhether crawls obey robots.txt.
bing_connectedbooleanA Bing Webmaster key is connected.
bing_site_urlstring | nullBing site URL when connected.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/links/settings \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"schedule": "weekly",
"brand_phrases": [
"Acme Bakery"
],
"crawl_budget": 500,
"respect_robots": true
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"schedule": "weekly",
"last_run_at": null,
"brand_phrases": [
"Acme Bakery"
],
"suggested_phrases": [
"acmebakery"
],
"crawl_budget": null,
"respect_robots": true,
"bing_connected": false,
"bing_site_url": null
}
}