Ir al contenido principal
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

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Redirect rule unique identifier

Ejemplo: 507f1f77bcf86cd799439011

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Cuerpo

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
Ejemplo: https://help.example.com/en/old/getting-started
helpCenterIdstring

Help center identifier

Required string length: 1 - 16
Patrón: ^[a-zA-Z0-9]+$
Ejemplo: ox6qrqprmsuqaunj
localeenum<string>

Locale code for the redirect rule

Opciones disponibles: 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
Ejemplo: en
targetIdstring

ID of the target article or collection

Required string length: 1 - 16
Patrón: ^[a-zA-Z0-9]+$
Ejemplo: 10021362
targetTypeenum<string>

Type of content the redirect points to

Opciones disponibles: article, collection
Ejemplo: article

Respuesta

application/json

Success

createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2026-02-11T12:00:00.000Z
fromUrlstringobligatorio

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

Ejemplo: https://help.example.com/en/old/getting-started
helpCenterIdstringobligatorio

Help center identifier

Ejemplo: ox6qrqprmsuqaunj
idstringobligatorio

Redirect rule unique identifier

Ejemplo: 507f1f77bcf86cd799439011
localeenum<string>obligatorio

Locale code for the redirect rule

Opciones disponibles: 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
Ejemplo: en
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: redirect_rule
Ejemplo: redirect_rule
targetIdstringobligatorio

Target article or collection ID

Ejemplo: 1234567
targetTypeenum<string>obligatorio

Type of content the redirect points to

Opciones disponibles: article, collection
Ejemplo: article
updatedAtstringobligatorio

ISO 8601 timestamp when last updated

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

¿Aún necesitas ayuda? Pregunta al equipo