Shortcuts.update (Method)
Save a new or updates an existing content shortcut.
Returns:
ShortcutID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
shortcutID | ShortcutID | Required | A shortcut's ID. If this value is 0, CommonSpot creates a new shortcut. |
shortcutType | ShortcutType | Required | A string defining the shortcut type, as follows: 'ExternalURL', 'GlobalCustomElement', 'Image', 'Page', 'MultimediaFile', 'MultimediaPlaylist' or 'UploadedDocument'. |
title | PlainText_NonNull_255 | Required | A shortcut's title. |
description | PlainText_2000 | Required | The shortcut's description. |
templatePageID | PageID_0 | Optional. Defaults to '0'. | If the shortcut type is 'New Page', this is ID of the template from which the page will be created. If this value is 0, CommonSpot does not creat a new page. |
subsiteID | SubsiteID_0 | Optional. Defaults to '0'. | The subsite's ID. If this value is 0, CommonSpot updates this shortcut. |
globalCustomElementID | GlobalCustomElementID_0 | Optional. Defaults to '0'. | The ID of a global custom element. A value of 0 indicates that this is not a global custom element. |
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 | hybrid:UpdateShortcut |
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'. |
Notes:
None