Method Details
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Scope:
Create a new URL mapping.
There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Scope:
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth access token or private app access token | Authorization: Bearer {token} header | Used to authenticate the request. Please see this page for more details about authentication. |
| Parameter name | Description |
|---|---|
| casing | Use the casing=snake parameter to change the API's casing for allowed JSON fields (below) to snake_case, rather than camelCase, which is the default. This option is provided for backwards-compatibility and ease of migration from Content v2 APIs, which used snake_case. |
| Field name | Type | Description |
|---|---|---|
| routePrefix | string | The incoming URL, path, or pattern to match |
| destination | string | The URL to redirect to |
| redirectStyle | int | The type of redirect this mapping will create: 301 (permanent) or 302 (temporary) |
| isMatchFullUrl | boolean | If true, the 'routePrefix' should match on the entire URL including the domain |
| isMatchQueryString | boolean | If true, the 'routePrefix' should match on the entire URL path including the query string |
| isOnlyAfterNotFound | boolean | If True, the URL mapping will only be applied if a live page matching the URL is not found. If False, the URL mapping will take precedence over any existing page |
| isPattern | boolean | Set to true if you are creating a flexible pattern based URL Mapping. |
| precedence | integer | If a URL matches more than one mapping, the one with the lower precedence applies |