Update the SEO details of an article

You can use the v3 API to update an article's SEO metadata, such as the SEO (meta) title, meta description and URL slug. In v3 these live under the article settings resource.

Note

SEO and other article preferences are managed through the article settings endpoint using PATCH. Every field is optional. Send only what you want to change. featured_image_url is read-only and cannot be set through the API.

Step 1 - View the current settings

Retrieve the existing settings, including seo_title, description and slug.

GET /v3/projects/{project_id}/articles/{article_id}/settings?lang_code=en

{
  "success": true,
  "request_id": "req_abc123def456",
  "data": {
    "slug": "getting-started-with-single-sign-on",
    "seo_title": "SSO Setup Guide - Product Documentation",
    "description": "Step-by-step instructions for configuring single sign-on.",
    "tags": ["SSO", "authentication", "SAML", "OIDC"],
    "exclude_from_search": false,
    "exclude_from_external_search": false,
    "custom_fields": []
  }
}

Step 2 - Update the SEO details

Send a PATCH request containing only the SEO fields you want to change.

PATCH /v3/projects/{project_id}/articles/{article_id}/settings?lang_code=en

curl --request PATCH "https://apihub.document360.io/v3/projects/{project_id}/articles/{article_id}/settings?lang_code=en" \
  --header "X-API-Key: YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "seo_title": "SSO Setup Guide - Product Documentation",
    "description": "Step-by-step instructions for configuring single sign-on with SAML or OIDC providers.",
    "slug": "getting-started-with-single-sign-on",
    "tags": ["SSO", "authentication", "SAML", "OIDC"]
  }'

Field	Description
`seo_title`	The SEO / meta title shown in search results and the browser tab.
`description`	The meta description.
`slug`	The URL slug of the article.
`tags`	Array of tag names.
`exclude_from_search`	Hide the article from in-site search.
`exclude_from_ai_search`	Exclude the article from AI search.
`exclude_from_external_search`	Prevent indexing by external search engines.
`related_articles`	Array of related article IDs.

A successful update returns 200 OK with the updated settings. Only the fields included in the request are modified.

Note

Any field you include overwrites its current value. Omit every field you do not wish to change. This endpoint also manages other article preferences beyond SEO; see the article settings reference for the full list.