Show Menu
TOPICS×

deleteVignettePublishFormat

Deletes a vignette publish format.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (deleteVignettePublishFormatParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company to which the vignette belongs.
* vignetteFormatHandle *
xsd:string
Yes
The handle to the vignette publish format to be deleted.
Output (deleteVignettePublishFormatParam)
The IPS API does not return a response for this operation.

Examples

This code sample deletes a vignette publish format specified by its handle.
Request
<deleteVignettePublishFormatParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <vignetteFormatHandle>v|21|282</vignetteFormatHandle>
</deleteVignettePublishFormatParam>

Response
None.