curl --request PATCH \
--url https://api.hubapi.com/cms/v3/url-redirects/{urlRedirectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination": "<string>",
"id": "<string>",
"isMatchFullUrl": true,
"isMatchQueryString": true,
"isOnlyAfterNotFound": true,
"isPattern": true,
"isProtocolAgnostic": true,
"isTrailingSlashOptional": true,
"precedence": 123,
"redirectStyle": 123,
"routePrefix": "<string>",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
'{
"destination": "<string>",
"id": "<string>",
"isMatchFullUrl": true,
"isMatchQueryString": true,
"isOnlyAfterNotFound": true,
"isPattern": true,
"isProtocolAgnostic": true,
"isTrailingSlashOptional": true,
"precedence": 123,
"redirectStyle": 123,
"routePrefix": "<string>",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}Update a redirect
Updates the settings for an existing URL redirect.
curl --request PATCH \
--url https://api.hubapi.com/cms/v3/url-redirects/{urlRedirectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destination": "<string>",
"id": "<string>",
"isMatchFullUrl": true,
"isMatchQueryString": true,
"isOnlyAfterNotFound": true,
"isPattern": true,
"isProtocolAgnostic": true,
"isTrailingSlashOptional": true,
"precedence": 123,
"redirectStyle": 123,
"routePrefix": "<string>",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
'{
"destination": "<string>",
"id": "<string>",
"isMatchFullUrl": true,
"isMatchQueryString": true,
"isOnlyAfterNotFound": true,
"isPattern": true,
"isProtocolAgnostic": true,
"isTrailingSlashOptional": true,
"precedence": 123,
"redirectStyle": 123,
"routePrefix": "<string>",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
The destination URL, where the target URL should be redirected if it matches the routePrefix.
The unique ID of this URL redirect.
Whether the routePrefix should match on the entire URL, including the domain.
Whether the routePrefix should match on the entire URL path, including the query string.
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.
Whether the routePrefix should match based on pattern.
Whether the routePrefix should match both HTTP and HTTPS protocols.
Whether a trailing slash will be ignored.
Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used.
The target incoming URL, path, or pattern to match for redirection.
The date and time when the URL mapping was initially created.
The date and time when the URL mapping was last modified.
Response
successful operation
The destination URL, where the target URL should be redirected if it matches the routePrefix.
The unique ID of this URL redirect.
Whether the routePrefix should match on the entire URL, including the domain.
Whether the routePrefix should match on the entire URL path, including the query string.
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.
Whether the routePrefix should match based on pattern.
Whether the routePrefix should match both HTTP and HTTPS protocols.
Whether a trailing slash will be ignored.
Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used.
The target incoming URL, path, or pattern to match for redirection.
The date and time when the URL mapping was initially created.
The date and time when the URL mapping was last modified.
Was this page helpful?