Sign in
Groups

Create New Group

Creates a new group within your organization. Supply a name for the group. Optionally provide created_by_user_id (the VOMO user ID of the group owner, who must be a member of your organization), a parent_id to nest the group under an existing group, and a members array of user IDs to immediately add members upon creation.

post/groups

Request body

namestring required

The name of the group

descriptionstring nullable

A description for the group

member_monikerstring

A word describing a group member

subgroup_monikerstring

A word describing subgroups

created_by_user_idinteger

Optional. If provided, must be an existing user who is a member of the organization.

parent_idinteger

The VOMO Group ID to set as the parent group of the newly created group

membersinteger[]

User IDs to set as the group's membership. On create (POST), these become the initial members. On update (PUT), this replaces the existing membership — any current member omitted from the array is removed from the group. Pass an empty array to clear all members.

Example request

{
  "name": "Morning Crew",
  "description": "A group for the morning crew to organize",
  "member_moniker": "Member",
  "subgroup_moniker": "Subgroup"
}

Response

Returns the newly created group record. Note: on success this endpoint returns 200 OK, not 201 Created.

Example response

{
  "data": {
    "name": "Afternoon Team",
    "description": "This team will take over for the morning team at 12pm",
    "has_subgroups": true,
    "created_at": "2016-03-07T07:49:41+00:00",
    "updated_at": "2016-03-07T07:49:41+00:00"
  }
}

Changes