PUT api/groups/{id}/members?field={field}&clearGroup={clearGroup}

Add a list of Users to a group (Available to Admin Accounts Only)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique group id

 integer

Required
field

What field to use when finding a user - 'id', 'username' or 'email' are valid options.

 string

Default value is id
clearGroup

Set this to true to empty the group first and then just add these new users, the group will then consist only of this users passed in for this call.

 boolean

Default value is False

Body Parameters

The List of Users, the values used will match against the field to find the user.

Collection of string

Request Formats

application/json, text/json

Sample: 
[
  "sample string 1",
  "sample string 2"
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.