saveGroup

Create or edit a group.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (saveGroupParam)

Name Type Required Description
*companyHandle* xsd:string Yes The handle to the company with the group you want to save.
*groupHandle* xsd:string No The handle to the group.
*name* xsd:string Yes Group name.
*isSystemDefined* xsd:boolean Yes false is default.

Output (saveGroupReturn)

Name Type Required Description
*groupHandle* xsd:string Yes Group handle.

Examples

This code sample creates a group that belongs to a specific company. If the group already exists, it is saved with the parameter values that you specify.

Request

<ns1:saveGroupParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:name>My Other Group</ns1:name>
   <ns1:isSystemDefined>false</ns1:isSystemDefined>
</ns1:saveGroupParam>

Response

<saveGroupReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <groupHandle>281</groupHandle>
</saveGroupReturn>

On this page