Skip to content
Home/
REST API Reference
/
/
Help Center Redirect

Help Center Redirect

A redirect maps a source URL (from_url) to an article or collection within a help center, so that links to old or external URLs resolve to live content.

idstring

The unique identifier for the redirect.

Example:"26"
typestring

The type of the object - help_center_redirect.

Value:"help_center_redirect"
Example:"help_center_redirect"
from_urlstring

The source URL that is redirected. An absolute URL within the help center's URL space.

Example:"http://help-center.test/lovelyhelpcenter/old-page"
localestring

The locale of the redirect's target. For article targets this is the bound translation's locale, which may differ from the requested locale if no translation exists in that locale.

Example:"en"
help_center_idstring

The unique identifier for the help center the redirect belongs to.

Example:"7"
target_typestring

The type of the redirect target.

Enum:"article""collection"
Example:"article"
target_idstring

The unique identifier of the target article or collection. For article targets this is the Article ID.

Example:"11"
created_atinteger

The time the redirect was created as a UTC Unix timestamp.

Example:1781619405
updated_atinteger

The time the redirect was last updated as a UTC Unix timestamp.

Example:1781619405
{
  "id": "26",
  "type": "help_center_redirect",
  "from_url": "http://help-center.test/lovelyhelpcenter/old-page",
  "locale": "en",
  "help_center_id": "7",
  "target_type": "article",
  "target_id": "11",
  "created_at": 1781619405,
  "updated_at": 1781619405
}