events.addMembersToGroupByFilters
Syntax
bool events.addMembersToGroupByFilters (
int vhost,
int groupID,
array filters = array(),
bool removeExistingMembers = false )
Argument Info
| Name | Type | Required | Default value | Description |
|---|
| vhost | int | Required | none | The vhost ID that the group and user belong to. |
| groupID | int | Required | none | The ID of the group that you are adding the user to. |
| filters | array | Optional | array() | getUsers filter - please see users.getUsers for further details. |
| removeExistingMembers | bool | Optional | false | If set to TRUE/1 all members of the group will be removed before the new users are added, otherwise new users will be added to existing |
Response
Will return whether or not the member has been successfully added to the desired group.
| Name | Type | Description |
|---|
| result | INT | Upon success the response will be 1. |
Return Values
| Field | Description | Possible Values |
|---|
