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

Update a redirect rule

PATCH/v2/help_center/redirect_rules/{id}

Updates an existing redirect rule. Only include the fields you wish to update.

If fromUrl is provided, it will be re-normalized and validated against the Help Center’s custom domain. If targetType or targetId is changed, the new target must exist and have a resolvable URL.

Path Parameters

  • id - The unique identifier of the redirect rule to update

Request Body

All fields are optional. Only provided fields will be updated:

  • helpCenterId - The help center ID
  • locale - Locale code
  • fromUrl - Updated source URL (will be re-normalized)
  • targetType - “article” or “collection”
  • targetId - ID of the new target article or collection

Response

Returns the updated redirect rule object.

Errors

  • 404 - Redirect rule not found
  • 400 - Invalid data, domain mismatch, duplicate fromUrl, or target not found
Path ParametersExpand Collapse
id: string

Redirect rule unique identifier

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: optional 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: optional string

Help center identifier

minLength1
maxLength16
locale: optional "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"
targetId: optional string

ID of the target article or collection

minLength1
maxLength16
targetType: optional "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

Update a redirect rule

curl https://do.featurebase.app/v2/help_center/redirect_rules/$ID \
    -X PATCH \
    -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"
}