Update a url mapping

PUT /url-mappings/v3/url-mappings/:url_mapping_id

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Updates a Url Mapping.
If not all the fields are included in the body, we will only update the included fields.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
url_mapping_id Used in the request URL Unique identifier for a particular url mapping to update

Optional query string parameters

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.

Allowed JSON Fields in the body

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