Shortcuts.create (Method)

Creates a new short cut.

Returns:

ShortcutID (integer)

Arguments:

Name Type Required Description
shortcutType ShortcutType Required The shortcut's type. Values are 'RegisteredURL', 'GlobalCustomElement', 'Image', 'Page', 'MultimediaFile', 'MultimediaPlaylist' and 'UploadedDocument'.
title PlainText_NonNull_255 Required The shortcut's title. This the text that appears in the dashboard.
description PlainText_2000 Required The shortcut's description.
templatePageID PageID_0 Optional. Defaults to '0'. The ID of the template from which the page will be created. If 0 no template is specified (the user will have to specify the template when invoking the shortcut).
subsiteID SubsiteID_0 Optional. Defaults to '0'. A subsite's ID. If this value is 0 when creating a shortcut for a page, then no subsite is specified and the user will have to choose the subsite when invoking the shortcut. For all other shortcut types, a valid non-zero subsite ID must be passed.
globalCustomElementID GlobalCustomElementID_0 Optional. Defaults to '0'. A global custom element's ID.
multimediaChannelID MultimediaChannelID_0 Optional. Defaults to '0'. ID of a multimedia channel.
imagegalleryID ImageGalleryID_0 Optional. Defaults to '0'. ID of an image gallery.

Context:

License Requirements None
Permission Requirements Contributor
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 Customization is not supported for this method.

Error Codes:

Code Error Message
44001 You already have a shortcut whose name is $1.
44005 You must provide a valid page template or a website location if the ShortcutType is 'New Page'.
44006 TemplatePageID must be 0 if the ShortcutType is not 'New Page'.
44008 You must provide a valid global custom element if the ShortcutType is 'New Global Custom Element Data'.

Notes:

None