Subsite.rename (Method)

Renames the current subsite.

Returns:

JobID (integer)

Arguments:

Name	Type	Required	Description
subsiteIDOrURL	SubsiteIDorURL_EmptyString	Required	The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite.
subsiteName	SubsiteName	Required	The subsite's name. This is the name used to construct the subsite's directory.
displayName	PlainText_255	Optional. Defaults to an empty string.	The subsite's menu name. This is the name used in breadcrumb elements.
description	PlainText_2000	Optional. Defaults to an empty string.	Text describing the current subsite.
addPermanentRedirect	Boolean	Optional. Defaults to '1'.	Boolean flag which when set indicates that a permanent redirect entry will be added.

Context:

License Requirements	(none)
Permission Requirements	subsite:SubsiteAdmin
Deny Context	None
Require Context	(none)
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
54016	A directory with the specified new name '$1' for the current subsite already exists with the same path. Please select another name and try again.
54017	You cannot rename a root subsite from the subsite scope.

Notes:

None