addGroupMembership

Adds a user to an array of groups.

Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (addGroupMembershipParam)

Name

Type

Required

Description

userHandle xsd:string

No

Handle to the user whose group membership you want to add.

groupHandleArray xsd:HandleArray

Yes

Array of handles to the groups you want the company to belong to.

Output (addGroupMembershipParam)

The IPS API does not return a response for this operation.

Examples

This example adds a group to a company with *groupHandleArray*. This example uses one group only.

Request

<ns1:addGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:groupHandleArray><ns1:items>225</ns1:items></ns1:groupHandleArray>
</ns1:addGroupMembershipParam>

Response

None.

On this page