v1

latestOpenAPI 3.0.02026-08-062438369.6 KB

Groups

Update A Group's Members

Replaces the specified group's membership with exactly the set of user IDs provided. This is NOT additive: any current member whose ID is omitted is removed from the group, and the supplied IDs become the complete membership. All provided user IDs must be members of your organization. Returns the updated paginated list of group members after the change.

put/groups/{id}/members

Path parameters

idinteger required

The unique VOMO identifier for the group whose membership to update.

Request body

membersinteger[] required

The VOMO user IDs that will become the group's complete membership. This replaces the existing members — any current member whose ID is omitted is removed. Each ID must correspond to a user who is a member of your organization.

Response

Returns the updated paginated list of group members after the membership has been replaced.

Example response

{
  "data": [
    {
      "type": "user",
      "id": "1",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "email": "person@vomo.org",
      "address": "610 Elm St, McKinney, TX 75069, USA",
      "phone": "1234567890",
      "birthday": "1975-12-01",
      "gender": "M",
      "updated_at": "2016-03-07T07:49:41+00:00",
      "created_at": "2016-03-07T07:49:41+00:00",
      "user_status": "VERIFIED",
      "membership_status": "ACCEPTED",
      "membership_role": "VOLUNTEER"
    }
  ]
}