---
title: "Create URL Redirect"
method: POST
path: "/cms/url-redirects/2026-09"
tags: ["Basic"]
---

# Create URL Redirect

`POST /cms/url-redirects/2026-09`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/cms/url-redirects/2026-09`
- Auth: OAuth 2
  - Authorization code: `https://app.hubspot.com/oauth/authorize`
  - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `content`

Create a new URL redirect in your HubSpot account. This endpoint allows you to define the destination URL, redirect style, and route prefix for the redirect. It is useful for managing URL redirections and ensuring that users are directed to the correct pages.

## Request body

- UrlMappingCreateRequestBody
  - `destination` string, required: The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
  - `isMatchFullUrl` boolean: Whether the `routePrefix` should match on the entire URL, including the domain.
  - `isMatchQueryString` boolean: Whether the `routePrefix` should match on the entire URL path, including the query string.
  - `isOnlyAfterNotFound` boolean: Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.
  - `isPattern` boolean: Whether the `routePrefix` should match based on pattern.
  - `isProtocolAgnostic` boolean: Whether the `routePrefix` should match both HTTP and HTTPS protocols.
  - `isTrailingSlashOptional` boolean: Whether a trailing slash will be ignored.
  - `precedence` integer: Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.
  - `redirectStyle` integer, required: The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).
  - `routePrefix` string, required: The target incoming URL, path, or pattern to match for redirection.

## Response `201`

successful operation

- UrlMapping
  - `created` string, date-time, required: The date and time when the URL mapping was initially created.
  - `destination` string, required: The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
  - `id` string, required: The unique ID of this URL redirect.
  - `isMatchFullUrl` boolean, required: Whether the `routePrefix` should match on the entire URL, including the domain.
  - `isMatchQueryString` boolean, required: Whether the `routePrefix` should match on the entire URL path, including the query string.
  - `isOnlyAfterNotFound` boolean, required: Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.
  - `isPattern` boolean, required: Whether the `routePrefix` should match based on pattern.
  - `isProtocolAgnostic` boolean, required: Whether the `routePrefix` should match both HTTP and HTTPS protocols.
  - `isTrailingSlashOptional` boolean, required: Whether a trailing slash will be ignored.
  - `precedence` integer, required: Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.
  - `redirectStyle` integer, required: The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).
  - `routePrefix` string, required: The target incoming URL, path, or pattern to match for redirection.
  - `updated` string, date-time, required: The date and time when the URL mapping was last modified.

## Other responses

- `default`: An error occurred.

## Changes

- **2026-09-03** (2026-09) `f8edc7860df0`: 2 info
  - api operation id `post-/cms/url-redirects/2026-09_/cms/url-redirects/2026-09` removed and replaced with `post-/cms/url-redirects/2026-09_/cms/url-redirects/v3`
  - the endpoint scheme security `private_apps` was removed from the API

[Operation history](https://skmtc.dev/hubspot/apis/cms-url-redirects/changes/cms/url-redirects/2026-09/post.md)

---

[API](https://skmtc.dev/hubspot/apis/cms-url-redirects.md) - [All operations](https://skmtc.dev/hubspot/apis/cms-url-redirects/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/cms-url-redirects/revisions/68565e891880?raw)
