Groups API

Create groups on your community. To manage the users in a group, see Group users. Before you start, read the API overview for how authentication, headers, pagination and errors work.

Create a group

Create a new group. The response includes the group’s uuid, which you use to identify the group in other endpoints.

string

required

The name of the new group.

string

required

The group type. Must be Person or Organisation.

string

required

The user type. Must be Admin or Student.

Create a group

curl -X POST "https://your-community.zapnito.com/api/v1/groups" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"group": {"name": "Expert Users", "group_type": "Person", "user_type": "Admin"}}'

POST https://your-community.zapnito.com/api/v1/groups

{
  "group": {
    "name": "Expert Users",
    "group_type": "Person",
    "user_type": "Admin",
    "uuid": "a1ecad96-8849-45ba-821e-20199cde45cd"
  }
}

{
  "errors": {
    "name": ["can't be blank"],
    "group_type": ["must be one of: Person/Organisation"],
    "user_type": ["must be one of: Admin/Student"]
  }
}

200 OK: the group was created.
422 Unprocessable Entity: a required parameter is missing or invalid.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

Create a group

​Create a group

Create a group