Skip to main content
POST
Create redirection
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
to_path
string
required
Example:

"https://example.com/new-page"

from_path
string

Path to redirect from, such as /old-page. Its last segment cannot contain a .. Needed for a page redirection. For a domain redirection, leave it out to use the knowledge base URL of the workspace, or send a bare origin such as https://old.example.com.

Example:

"/old-page"

redirection_type
enum<string>
default:page
Available options:
page,
domain

Response

Created - Redirection created

redirection
object