Skip to main content
POST
Create URL redirect

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose URL redirects you want to work with.

Body

application/json
source_path
string
required

Path visitors request, starting with / and carrying no query string or fragment. Base44 strips a trailing slash and decodes percent-escapes before storing it, so /old/ and /%6Fld are the same rule.

Required string length: 1 - 512
Example:

"/old-pricing"

target_path
string
required

Where to send the visitor. Either an internal path starting with /, normalized the same way as source_path, or an absolute https:// URL on another site, kept as you sent it. Send it without a query string or fragment. The visitor's own query string is carried over to the destination, so /old?utm=x lands on /new?utm=x.

Required string length: 1 - 512
Example:

"/pricing"

match_type
enum<string>
default:single

Use single to redirect that exact path, or prefix to redirect it and everything under it, keeping the remainder of the path. Defaults to single, so omitting it on an update turns an existing prefix rule into a single one and its child paths stop redirecting.

Available options:
single,
prefix
Example:

"single"

Response

The redirect that was created.

One 301 redirect rule on the app's published site.

id
string
required

ID of the redirect. Pass it as redirect_id to Update URL redirect and Delete URL redirect.

Example:

"68c2d1e5f3b8a4216e9b5583"

source_path
string
required

The path visitors request, normalized with no trailing slash and percent-escapes decoded.

Example:

"/old-pricing"

target_path
string
required

Where the visitor is sent. Either an internal path, normalized the same way as source_path, or an absolute https:// URL on another site, kept exactly as you sent it.

Example:

"/pricing"

match_type
enum<string>
required

How the rule matches. A single rule redirects that exact path, and a prefix rule redirects it and everything under it, keeping the remainder of the path.

Available options:
single,
prefix
Example:

"single"