Show Menu
TOPICS×

deleteImageFormat

Deletes an image format. Get the image format handle from saveImageFormat.
Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (deleteImageFormatParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company that contains the image format that you want to delete.
* imageFormatHandle *
xsd:string
Yes
The handle to the image format you want to delete.
Output (deleteImageFormatParam)
The IPS API does not return a response for this operation.

Examples

This code sample deletes an image format from a company. Obtain the image format handle from another operation.
Request
<deleteImageFormatParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <imageFormatHandle>47|301</imageFormatHandle>
</deleteImageFormatParam>

Response
None.
Related Topic: