Create Redirect

POST 
/funnels/lookup/redirect

The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload.

Request

Version stringrequired

API Version

Available optionsv4

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Identifier of the location the redirect belongs to

domainstringrequired

Domain the redirect is served from

pathstringrequired

Path on the domain that triggers the redirect

targetstringrequired

Destination the redirect points to

actionstringrequired
How the redirect resolves its target
Available optionsfunnelwebsitewebinarurlall

Example (auto)

{
  "locationId": "6p2RxpgtMKQwO3E6IUaT",
  "domain": "example.com",
  "path": "/Hello",
  "target": "https://www.google.com",
  "action": "url"
}

application/json

Successful response

application/json

Schema

Schema

dataobjectrequired

Data containing details of the created redirect

Example (auto)

{
  "data": {
    "id": "6p2RxpgtMKQwO3E6IUaT",
    "locationId": "6p2RxpgtMKQwO3E6IUaT",
    "domain": "www.example.com",
    "path": "/old-path",
    "pathLowercase": "/old-path",
    "type": "Permanent",
    "target": "https://www.example.com/new-path",
    "action": "url"
  }
}