Show Menu
TOPICS×

setCompanyMembership

Sets a user’s membership in one or more companies.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (setCompanyMembershipParam)
Name
Type
Required
Description
* userHandle *
xsd:sting
No
User handle.
* membershipArray *
types:CompanyMembershipUpdateArray
Yes
Array of companies.
Output (setCompanyMembershipParam)
The IPS API does not return a response for this operation.

Examples

This code sample adds a user to a company. Specify multiple companies in the company handle array if required.
Request
<ns1:setCompanyMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>3341|juser@scene7.com</ns1:userHandle>
   <ns1:companyHandleArray>
      <ns1:items>137</ns1:items>
   </ns1:companyHandleArray>
</ns1:setCompanyMembershipParam>

Response
None.