manage group member
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9100 | 5.9802 | xml, json |
Description
Edit the membership details for a member.
Group membership parameters
If a group is specified on the request, the new member is also added to the group. All group membership parameters are optional, and default to the group’s default values.
The notification parameter must be one of immediate, essential, daily, weekly or none. Users are able to subsequently change this setting through the user interface in their group registration options.
The role parameter must be one of guest, reviewer, contributor, manager, approver, moderator-and-approver, moderator.
The listed boolean parameter can be used to override the group’s default setting. It affects whether other group members are able to see the member’s user details. Users are able to subsequently change this setting through the user interface in their group registration options.
Registration / Deregistration
This service can be used to register/deregister a member to/from group by using the appropriate parameters ( register and deregister respectively).
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| deregister | Set to true to deregister the member from the group | no | boolean | false |
| field1 | Custom field #1 | no | string | |
| field10 | Custom field #10 | no | string | |
| field11 | Custom field #11 | no | string | |
| field12 | Custom field #12 | no | string | |
| field13 | Custom field #13 | no | string | |
| field14 | Custom field #14 | no | string | |
| field15 | Custom field #15 | no | string | |
| field2 | Custom field #2 | no | string | |
| field3 | Custom field #3 | no | string | |
| field4 | Custom field #4 | no | string | |
| field5 | Custom field #5 | no | string | |
| field6 | Custom field #6 | no | string | |
| field7 | Custom field #7 | no | string | |
| field8 | Custom field #8 | no | string | |
| field9 | Custom field #9 | no | string | |
| listed | Whether the member’s email address is listed in the group | no | boolean | |
| notification | The member’s notification option in the group | no | enum | |
| register | Set to true to register the member to the group | no | boolean | false |
| role | The member’s role in the group (cannot be used if deregister=true) | no | enum | |
| welcome-email | Whether to send a group welcome email to the member | no | boolean | true |
| notify-async | Whether to send emails asynchronously (for slow email servers) | no | boolean | false |
Permission
This service can only be invoked by a manager in the group or an administrator .
Response
When successful, the XML returned the full details of the updated membership as a <membership> element wrapped in a <membership-modification>:
<membership-modification>
<membership id="[membershipid]"
email-listed="[true|false]"
notification="[none|
essential|
immediate|
daily|
weekly]"
flags="[flags]"
[status="[status]"]
[role="[role]"]>
<member id="[member id]"
firstname="[first name]"
surname="[surname]"
username="[username]"
status="[activated|
unactivated|
set-password]">
<fullname>[full name]</fullname>
</member>
<group id="[group id]"
name="[name]"
visibility="[visibility]"
template="[template]">
<description>[description]</description>
</group>
</membership>
</membership-modification>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1006 | If the user is not a member of the group |
| 0x1007 | Unabled to find matching group |
| 0x100D | If the specified role is illegal |
| 0x1014 | If the user attempts to deregister and register or change his role at the same time |
| 0x6004 | If the member details have not been configured properly |