Show Menu
TOPICS×

deleteGroup

Deletes a group.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (deleteGroupParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company that belongs to the group that you want to delete.
* groupHandle *
xsd:string
Yes
The handle to the group that you want to delete.
Output (deleteGroupParam)
The IPS API does not return a response for this operation.

Examples

This sample code deletes a group from a company. It requires a group handle, which you must obtain from another operation.
Request
<ns1:deleteGroupParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:groupHandle>241</ns1:groupHandle>
</ns1:deleteGroupParam>

Response
None.