Organization API: Organizations & Members: Seo

Part of Organizations & Members.

GET /api/v1/orgs/{org_slug}/seo

The organization's saved search settings, with what each empty field falls back to and the limits each field has.

seo is the saved block: site_name, alt_names, home_title, home_description, og_image, og_image_alt, social (a map of network to link), verification (google, bing, yandex and the three ..._file names), robots_extra, redirects (from, to and status), indexnow_key and hold_indexing. defaults are the brand's own words an empty field uses. networks lists the profiles a link may name with the addresses each belongs on, host is the storefront's address (has_storefront is false when the organization has none), files lists the addresses the storefront serves for the key and the verification files, and indexnow says whether pages can be sent now and, when they cannot, why. Any member may read it.

PUT /api/v1/orgs/{org_slug}/seo

Save the search settings sent. A field left out keeps its saved value, and an empty one goes back to the brand's default.

Needs the Owner or Admin role. A value that breaks a rule is refused with 400 and a sentence that names the field, and nothing is saved. The answer is the one GET gives, with changed listing each field that differs from before as old value and new value. Saving what is already stored changes nothing and writes no audit entry. The IndexNow key cannot be sent here: make it with POST /seo/indexnow-key. A change reaches storefront pages within a minute.

application/json (required)

POST /api/v1/orgs/{org_slug}/seo/indexnow-key

Make a new IndexNow key. The storefront serves it at /<key>.txt, which is how search engines know the pages sent to them are yours. A new key replaces the old one at once. Needs the Owner or Admin role.

DELETE /api/v1/orgs/{org_slug}/seo/indexnow-key

Remove the IndexNow key. The storefront stops serving the key file and stops sending changed pages to search engines. Needs the Owner or Admin role.

POST /api/v1/orgs/{org_slug}/seo/indexnow/submit

Send every page in the storefront's sitemap to IndexNow now, in batches of 100. Needs the Owner or Admin role and an IndexNow key, and answers 409 with the reason while indexing is on hold or the organization has no storefront. Limited to a few runs an hour for the whole organization, then 429.

GET /api/v1/orgs/{org_slug}/seo/test-path

What a visitor or a search engine gets for a path today, using the saved settings: kind is redirect (with redirect_to and status), indexable, noindex or not_found. The path starts with one / and has no spaces, else 400. 409 when the organization has no storefront.