HubSpot: Url redirects schemas

← Url redirects operations · All schemas

Create URL Mapping — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
created	string	Required within parent	The date and time when the URL mapping was initially created. Format: date-time
destination	string	Required within parent	The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
id	string	Required within parent	The unique ID of this URL redirect.
isMatchFullUrl	boolean	Required within parent	Whether the `routePrefix` should match on the entire URL, including the domain.
isMatchQueryString	boolean	Required within parent	Whether the `routePrefix` should match on the entire URL path, including the query string.
isOnlyAfterNotFound	boolean	Required within parent	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 within parent	Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic	boolean	Required within parent	Whether the `routePrefix` should match both HTTP and HTTPS protocols.
isTrailingSlashOptional	boolean	Required within parent	Whether a trailing slash will be ignored.
precedence	integer	Required within parent	Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used. Format: int32
redirectStyle	integer	Required within parent	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). Format: int32
routePrefix	string	Required within parent	The target incoming URL, path, or pattern to match for redirection.
updated	string	Required within parent	The date and time when the URL mapping was last modified. Format: date-time

Create URL Redirect — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
destination	string	Required within parent	The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
isMatchFullUrl	boolean	Optional	Whether the `routePrefix` should match on the entire URL, including the domain.
isMatchQueryString	boolean	Optional	Whether the `routePrefix` should match on the entire URL path, including the query string.
isOnlyAfterNotFound	boolean	Optional	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	Optional	Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic	boolean	Optional	Whether the `routePrefix` should match both HTTP and HTTPS protocols.
isTrailingSlashOptional	boolean	Optional	Whether a trailing slash will be ignored.
precedence	integer	Optional	Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used. Format: int32
redirectStyle	integer	Required within parent	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). Format: int32
routePrefix	string	Required within parent	The target incoming URL, path, or pattern to match for redirection.

List URL Redirects — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List URL Redirects — response body — paging
results	array	Required within parent	An array of UrlMapping objects, each representing a specific URL mapping.
results[]	Model	Each item	Expand Update a redirect — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of URL mappings available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List URL Redirects — response body — paging, Update a redirect — response body

List URL Redirects — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List URL Redirects — response body — paging next

Referenced models: List URL Redirects — response body — paging next

List URL Redirects — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor value indicating where to begin fetching the next page of results in a paginated collection.
link	string	Optional	An optional URL for directly accessing the next page of results.

Update a redirect — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
created	string	Optional	The date and time when the URL mapping was initially created. Format: date-time
destination	string	Optional	The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
id	string	Optional	The unique ID of this URL redirect.
isMatchFullUrl	boolean	Optional	Whether the `routePrefix` should match on the entire URL, including the domain.
isMatchQueryString	boolean	Optional	Whether the `routePrefix` should match on the entire URL path, including the query string.
isOnlyAfterNotFound	boolean	Optional	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	Optional	Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic	boolean	Optional	Whether the `routePrefix` should match both HTTP and HTTPS protocols.
isTrailingSlashOptional	boolean	Optional	Whether a trailing slash will be ignored.
precedence	integer	Optional	Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used. Format: int32
redirectStyle	integer	Optional	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). Format: int32
routePrefix	string	Optional	The target incoming URL, path, or pattern to match for redirection.
updated	string	Optional	The date and time when the URL mapping was last modified. Format: date-time

Update a redirect — response body

Field	Type	Presence	Description and constraints
$	object	Root
created	string	Required within parent	The date and time when the URL mapping was initially created. Format: date-time
destination	string	Required within parent	The destination URL, where the target URL should be redirected if it matches the `routePrefix`.
id	string	Required within parent	The unique ID of this URL redirect.
isMatchFullUrl	boolean	Required within parent	Whether the `routePrefix` should match on the entire URL, including the domain.
isMatchQueryString	boolean	Required within parent	Whether the `routePrefix` should match on the entire URL path, including the query string.
isOnlyAfterNotFound	boolean	Required within parent	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 within parent	Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic	boolean	Required within parent	Whether the `routePrefix` should match both HTTP and HTTPS protocols.
isTrailingSlashOptional	boolean	Required within parent	Whether a trailing slash will be ignored.
precedence	JSON	Required within parent
precedence (anyOf 1)	integer	Alternative	Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used. Format: int32
precedence (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
redirectStyle	JSON	Required within parent
redirectStyle (anyOf 1)	integer	Alternative	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). Format: int32
redirectStyle (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
routePrefix	string	Required within parent	The target incoming URL, path, or pattern to match for redirection.
updated	string	Required within parent	The date and time when the URL mapping was last modified. Format: date-time