Skip to content
Dashboard

Redirect Rules

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

List redirect rules
GET/v2/help_center/redirect_rules
Create a redirect rule
POST/v2/help_center/redirect_rules
Get a redirect rule by URL
GET/v2/help_center/redirect_rules/by-url
Get a redirect rule by ID
GET/v2/help_center/redirect_rules/{id}
Update a redirect rule
PATCH/v2/help_center/redirect_rules/{id}
Delete a redirect rule
DELETE/v2/help_center/redirect_rules/{id}
ModelsExpand Collapse
RedirectRule object { id, createdAt, fromUrl, 6 more }
id: string

Redirect rule unique identifier

createdAt: string

ISO 8601 timestamp when created

fromUrl: string

Canonical source URL being redirected from (query and hash stripped)

helpCenterId: string

Help center identifier

locale: "bn" or "bs" or "pt-BR" or 39 more

Locale code for the redirect rule

One of the following:
"bn"
"bs"
"pt-BR"
"bg"
"ca"
"hr"
"cs"
"da"
"nl"
"en"
"et"
"fi"
"fr"
"de"
"el"
"hi"
"hu"
"id"
"it"
"ja"
"ko"
"lv"
"lt"
"ms"
"mn"
"nb"
"pl"
"pt"
"ro"
"ru"
"sr"
"zh-CN"
"sk"
"sl"
"es"
"sw"
"sv"
"th"
"zh-TW"
"tr"
"uk"
"vi"
object: "redirect_rule"

Object type identifier

targetId: string

Target article or collection ID

targetType: "article" or "collection"

Type of content the redirect points to

One of the following:
"article"
"collection"
updatedAt: string

ISO 8601 timestamp when last updated

RedirectRuleDeleteResponse object { id, deleted, object }
id: string

Unique identifier of the deleted redirect rule

deleted: true

Indicates the resource was deleted

object: "redirect_rule"

Object type identifier