Update SEO settings

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Saves SEO settings for the app and returns the settings as they now stand.

This is a partial update even though it is a PUT. Keys you leave out of settings keep their saved values, and pages merges twice over: a page you don't mention keeps its overrides, and a field you don't send on a page you do mention keeps its saved value. Sending one page's title therefore leaves that page's description and every other page untouched.

<Note>You can't remove a page or a page override here. Sending pages: {} changes nothing, and a null page entry is rejected with a 422. To stop a page overriding a tag, send an empty string as that field's value.</Note>

Saving is immediate, and the copy the live site serves is refreshed right after on a best-effort basis. A 200 means the settings are stored, so re-read them with Get SEO settings rather than treating the published pages as confirmation.

This endpoint is limited to 30 requests per minute per app, and that budget is shared with the app's other SEO endpoints.

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time. Send only the fields documented here. Other request fields are not supported and their behavior can change.</Warning>

put/api/apps/{app_id}/seo/settings

Path parameters

app_idstring required

ID of the app whose SEO settings you want.

ID of the app whose SEO settings you want.

Request body

Example request

{
  "settings": {
    "platform_meta_injection_enabled": true,
    "platform_jsonld_injection_enabled": true,
    "robots_txt_enabled": true,
    "sitemap_xml_enabled": true,
    "ai_crawlers_enabled": true,
    "synthesized_breadcrumb_enabled": true,
    "canonical_url": "https://acme.com",
    "content_query_params": [
      "article"
    ],
    "custom_json_ld": [
      {
        "@context": "https://schema.org",
        "@type": "Product",
        "name": "Acme CRM"
      }
    ],
    "website_schema": {
      "@context": "https://schema.org",
      "@type": "WebSite",
      "name": "Acme CRM",
      "url": "https://acme.com"
    },
    "organization_schema": {
      "@context": "https://schema.org",
      "@type": "Organization",
      "name": "Acme",
      "url": "https://acme.com"
    },
    "breadcrumb_schema": {
      "@context": "https://schema.org",
      "@type": "BreadcrumbList",
      "itemListElement": []
    },
    "faq_schema": {
      "@context": "https://schema.org",
      "@type": "FAQPage",
      "mainEntity": []
    },
    "pages": {
      "Home": {
        "description": "Track leads and deals in one place.",
        "og_image": "https://cdn.example.com/acme-og.png",
        "title": "Acme CRM"
      }
    }
  }
}

Response

The settings as they stand after the merge.

Example response

{
  "result": {
    "platform_meta_injection_enabled": true,
    "platform_jsonld_injection_enabled": true,
    "robots_txt_enabled": true,
    "sitemap_xml_enabled": true,
    "ai_crawlers_enabled": true,
    "synthesized_breadcrumb_enabled": true,
    "canonical_url": "https://acme.com",
    "content_query_params": [
      "article"
    ],
    "custom_json_ld": [
      {
        "@context": "https://schema.org",
        "@type": "Product",
        "name": "Acme CRM"
      }
    ],
    "website_schema": {
      "@context": "https://schema.org",
      "@type": "WebSite",
      "name": "Acme CRM",
      "url": "https://acme.com"
    },
    "organization_schema": {
      "@context": "https://schema.org",
      "@type": "Organization",
      "name": "Acme",
      "url": "https://acme.com"
    },
    "breadcrumb_schema": {
      "@context": "https://schema.org",
      "@type": "BreadcrumbList",
      "itemListElement": []
    },
    "faq_schema": {
      "@context": "https://schema.org",
      "@type": "FAQPage",
      "mainEntity": []
    },
    "pages": {
      "Home": {
        "description": "Track leads and deals in one place.",
        "og_image": "https://cdn.example.com/acme-og.png",
        "title": "Acme CRM"
      }
    }
  }
}

Changes

Changed in 1 of the 15 revisions of this API.1