deleteFolder
Deletes a folder.
Syntax
Authorized User Types
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
NOTE
The user must have read and delete access to the folder and all of its children.
Parameters
Input (deleteFolderParam)
Name
Type
Required
Description
companyHandle
xsd:string
Yes
The handle to the company to which the folder belongs.
folderHandle
xsd:string
Yes
The handle to the folder to delete.
Output (deleteFolderParam)
The IPS API does not return a response for this operation.
Examples
This sample code deletes a folder from the root of the company. It requires a folder handle, which you must obtain from another operation.
Request
<ns1:deleteFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:folderHandle>MyCompany/SpinSets/</ns1:folderHandle>
</ns1:deleteFolderParam>
None.
4e9b9d8c-5839-4215-aa35-01b652869681