Redirects.create (Method)
Creates a new redirect entry and returns its unique id.
Returns:
RedirectID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
originalURL | RedirectableURL | Required | The server relative URL of the original URL that no longer exists. |
type | RedirectAction_Manual | Required | The type of redirect, manual or temporary. |
pageID | PageID | Required | The unique ID of the page to redirect to. |
description | PlainText_255 | Optional. Defaults to an empty string. | Description about the redirect. |
expireDate | FutureDate_EmptyString | Optional. Defaults to an empty string. | The date after which the permanent redirect entry should be removed. |
Context:
License Requirements | (none) |
Permission Requirements | Content:Author |
Deny Context | (none) |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | This method may be customized at the site level |
Error Codes:
Code | Error Message |
---|---|
80500 | |
80501 | Redirect support is not enabled for this site. |
80502 | |
80506 | A subsite with this original URL already exists. |
Notes:
None