Show Menu
TOPICS×

deleteZoomTarget

Deletes a zoom target.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
The user must have read and write access to the asset.

Parameters

Input (deleteZoomTargetParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company to which the zoom target belongs.
* zoomTargetHandle *
xsd:string
Yes
The handle to the zoom target to delete.
Output (deleteZoomTargetParam)
The IPS API does not return a response for this operation.

Example

This code sample deletes a zoom target from a company.
Request
<ns1:deleteZoomTargetParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:zoomTargetHandle>34194|9|301</ns1:zoomTargetHandle>
</ns1:deleteZoomTargetParam>

Response
None.