Skip to main content
PATCH
Update page SEO settings

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

page_name
string
required

Name of the page, the same key it has in pages in Get SEO settings. That's the page's component name as it appears in the app's code, with any folder under pages in front of it, such as About or services/HouseWashing. The home page goes by its own name, such as Home, not /. The name is case-sensitive, and you can send its slashes as they are or encoded as %2F.

app_id
string
required

ID of the app whose SEO settings you want.

Body

application/json
noindex
boolean | null

Set to true to hide the page from search engines, or false to make it visible again. Leaving it out or sending null keeps the saved value and returns the page's current settings.

Example:

true

ignore_parent_noindex
boolean | null

Set to true to keep this page visible to search engines when a parent page is hidden (e.g. /units/:id while Units is hidden). It never overrides the page's own noindex.

Example:

true

Response

The page's settings after the change.

result
SEOPageSettings · object
required

Settings saved for the page, or an empty object if the page has none and the call changes nothing.