Bold360 and BoldChat Developer Center

getSetupFolders

Lists all Canned Message folders.

Input parameter

Parameter Type Required Description
FolderType long no* Pass FolderType to return a filtered list of folders. See FolderType (ItemType) for a list of types.
ParentSetupFolderID long no

Possible values:

  • If a valid long ID is passed, returns the children of the specified parent.
  • If null is passed, returns items who's ParentSetupFolderID is also null.
  • If omitted, ancestors are not considered.
SetupFolderID long no* The Canned Message folder's ID to be returned.

* You must pass either a SetupFolderID and/or FolderType

Return values

Parameter Type Description
SetupFolderID long The folder's ID.
Name string The folder's friendly name.
FolderType long The folder's type. See FolderType (ItemType) for a list of types.
ParentSetupFolderID long The parent folder's ID.
AccountID integer The ID of the account that the folder is associated with.
Created datetime UTC folder creation date in ISO-8601 format.
Updated datetime UTC folder update date in ISO-8601 format.
Deleted boolean Indicates whether the folder has been deleted.
DeletedBy string id The AccountID of the user, who deleted the folder (if applicable).