Skip to main content
Help Centers

Update a redirect rule

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

PATCH
/v2/help_center/redirect_rules/{id}

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

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

Redirect rule unique identifier

Example: 507f1f77bcf86cd799439011

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Body

application/json
fromUrlstring

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.

Maximum string length: 2048
Example: https://help.example.com/en/old/getting-started
helpCenterIdstring

Help center identifier

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: ox6qrqprmsuqaunj
localeenum<string>

Locale code for the redirect rule

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, 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
Example: en
targetIdstring

ID of the target article or collection

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: 10021362
targetTypeenum<string>

Type of content the redirect points to

Available options: article, collection
Example: article

Response

application/json

Success

createdAtstringrequired

ISO 8601 timestamp when created

Example: 2026-02-11T12:00:00.000Z
fromUrlstringrequired

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

Example: https://help.example.com/en/old/getting-started
helpCenterIdstringrequired

Help center identifier

Example: ox6qrqprmsuqaunj
idstringrequired

Redirect rule unique identifier

Example: 507f1f77bcf86cd799439011
localeenum<string>required

Locale code for the redirect rule

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, 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
Example: en
objectenum<string>required

Object type identifier

Available options: redirect_rule
Example: redirect_rule
targetIdstringrequired

Target article or collection ID

Example: 1234567
targetTypeenum<string>required

Type of content the redirect points to

Available options: article, collection
Example: article
updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: 2026-02-11T12:00:00.000Z

Still need help? Ask the team