Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Help Center
Redirect Rules

Create a redirect rule

POST/v2/help_center/redirect_rules

Creates a new redirect rule in your organization.

The fromUrl is normalized on creation: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. The fromUrl hostname must match the Help Center’s configured custom domain.

The target article or collection must exist and have a resolvable URL (i.e., a published translation with a slug).

Request Body

Required attributes:

  • helpCenterId - The ID of the help center this rule belongs to
  • locale - Locale code used to resolve the target translation
  • fromUrl - The full absolute URL to redirect from (must match the help center’s custom domain)
  • targetType - “article” or “collection”
  • targetId - The ID of the target article or collection

Response

Returns the created redirect rule object.

Errors

  • 400 - Invalid request data, fromUrl does not match custom domain, or target not found
Header ParametersExpand Collapse
"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"
One of the following:
"2026-01-01.nova"
"2025-12-12.clover"
Body ParametersJSONExpand Collapse
fromUrl: string

Full absolute URL to redirect from. Must use http or https protocol. Query parameters and hash fragments are stripped during normalization. The hostname must match the Help Center custom domain.

maxLength2048
helpCenterId: string

Help center identifier this redirect rule belongs to

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

Locale code for the redirect rule. Used to resolve the target article/collection translation.

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"
targetId: string

ID of the target article or collection

minLength1
maxLength16
targetType: "article" or "collection"

Type of content the redirect points to

One of the following:
"article"
"collection"
ReturnsExpand 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

Create a redirect rule

curl https://do.featurebase.app/v2/help_center/redirect_rules \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY" \
    -d '{
          "fromUrl": "https://help.example.com/en/old/getting-started",
          "helpCenterId": "ox6qrqprmsuqaunj",
          "locale": "en",
          "targetId": "10021362",
          "targetType": "article"
        }'
{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "object": "redirect_rule",
  "targetId": "1234567",
  "targetType": "article",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}
Returns Examples
{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2026-02-11T12:00:00.000Z",
  "fromUrl": "https://help.example.com/en/old/getting-started",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "locale": "en",
  "object": "redirect_rule",
  "targetId": "1234567",
  "targetType": "article",
  "updatedAt": "2026-02-11T12:00:00.000Z"
}