Backend API to update existing SEO pages programmatically. Usage is charged from your credit balance.
Server-side only.updateSeoPage and the raw API must be called from the server only. Never use them in client-side code (e.g. React components, browser JavaScript)—the secret key would be exposed. Use API routes, server actions, or backend scripts instead.
Properties
Property
Type
Required
Description
pageIdentifiers
array of PageIdentifiers
Yes
An array of PageIdentifiers to identify which pages to update.
pageSEO
array of PageSEO
Yes
An array of PageSEO objects with the updated data.
options
Options
No
Additional options.
PageIdentifiers
Property
Type
Required
Description
path
string
Yes
The page path. Must begin with '/'.
pageId
string
No
The pageId of the SEO page. Optional alternative to path for identifying a page.
PageSEO
Property
Type
Required
Description
path
string
Yes
The page path. Must begin with '/'.
title
string
Yes
Page title.
description
string
No
Page description.
follow
"follow" or "nofollow"
No
Default: "follow"
index
"index" or "noindex"
No
Default: "index"
changeFreq
"daily" or "monthly" or "weekly"
No
Default: "weekly"
keywordsArray
string[]
No
Array of keywords.
priority
"1" to "0.1"
No
Default: "0.5"
ldsJSON
string
No
JSON-LD structured data as a string.
image
object with url
No
The url property must point to an externally hosted image file.
Options
Property
Type
Required
Description
upsert
boolean
No
Set to true to create the page if it does not already exist. Default: false