HUhubspot
Basic

Create URL Mapping

Changed on

Create a new URL mapping in your HubSpot account. This endpoint allows you to define a new URL redirect rule by specifying the route prefix, destination URL, and redirect style. The request body must include these required fields to successfully create a URL mapping.

post/cms/url-redirects/2026-09/url-mappings

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: content

Request body */*

createdstring date-time required

The date and time when the URL mapping was initially created.

destinationstring required

The destination URL, where the target URL should be redirected if it matches the routePrefix.

idstring required

The unique ID of this URL redirect.

isMatchFullUrlboolean required

Whether the routePrefix should match on the entire URL, including the domain.

isMatchQueryStringboolean required

Whether the routePrefix should match on the entire URL path, including the query string.

isOnlyAfterNotFoundboolean 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.

isPatternboolean required

Whether the routePrefix should match based on pattern.

isProtocolAgnosticboolean required

Whether the routePrefix should match both HTTP and HTTPS protocols.

isTrailingSlashOptionalboolean required

Whether a trailing slash will be ignored.

precedenceinteger required

Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used.

redirectStyleinteger required

The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details here.

routePrefixstring required

The target incoming URL, path, or pattern to match for redirection.

updatedstring date-time required

The date and time when the URL mapping was last modified.

Response

An error occurred.

categorystring required

The error category

contextobject

Context about the error condition

correlationIdstring uuid required

A unique identifier for the request. Include this value with any error reports or support tickets

linksobject

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

messagestring required

A human readable message describing the error along with remediation steps where appropriate

subCategorystring

A specific category that contains more specific detail about the error

Example response

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Changes