Pidgeon
  1. Groups
Pidgeon
  • Courses
    • Projects
      • Submission
        • Get submission by ID
        • Get all submissions for an existing project
        • Create a new submission for an existing project
        • Get submitted file of an existing submission
        • Delete an existing submission
        • Get all submissions from a group from a project
        • (removed) Get structure feedback of an existing submission
        • (removed) Get docker feedback for an existing submission
      • Get all projects for an existing course
      • Get all projects of a user
      • Get project by ID
      • Create a new project for an existing course
      • Update an existing project
      • Update an existing project
      • Get all groups of a project
      • Delete an existing project
      • Update the tests for an existing project
      • Update the tests for an existing project
      • Update the tests for an existing project
      • Get all tests for an existing project
      • Delete the tests of a project
      • Upload extra test files
      • Delete extra test files
      • Get extra test files
    • Group_clusters
      • Groups
        • Create a new group
          POST
        • Get group by ID
          GET
        • Update an existing group
          PUT
        • Update an existing group
          PATCH
        • Update project score for an existing group
          PATCH
        • Delete project score for an existing group
          DELETE
        • Update project score for an existing group
          PUT
        • Create project score for an existing group
          POST
        • Get project score for an existing group
          GET
        • Delete a member from an existing group
          DELETE
        • Delete the logged in user from a group
          DELETE
        • Add a member to an existing group
          POST
        • Add the logged in user to a group
          POST
        • Get all members of an existing group
          GET
        • (removed) Delete an existing group
          DELETE
      • Get all group clusters from an existing course
        GET
      • Create a new group cluster
        POST
      • Get a group cluster by ID
        GET
      • Update an existing group cluster
        PUT
      • Fill groups in group clusters by providing a map of groupids with lists of userids
        PUT
      • Update an existing group cluster
        PATCH
      • Delete an existing group cluster
        DELETE
    • Get user courses
      GET
    • Create a new course
      POST
    • Update an existing course
      PUT
    • Update an existing course
      PATCH
    • Get course by ID
      GET
    • Delete an existing course
      DELETE
    • Join course with a key
      POST
    • Get course information for joining course with key
      GET
    • Join course without a key
      POST
    • Get course information for joining course without key
      GET
    • Leave an existing course
      DELETE
    • Delete a member from an existing course
      DELETE
    • Add a member to an existing course
      POST
    • Update a member of an existing course
      PATCH
    • Get all members of an existing course
      GET
    • Get the join link for a course
      GET
    • Generate a new join link for a course
      PUT
    • Remove the joinKey from the joinLink of a course
      DELETE
    • Copy a course
      POST
    • Get grades for an existing course
      GET
    • (removed) Add a logged in member to an existing course
      POST
    • (removed) Get all your grades from a course
      GET
  • Users
    • Get user by ID
    • Get the logged in user
    • Search users by email, name and surname
    • Update user
    • Update user
  1. Groups

Update an existing group

Developing
PATCH
/groups/{groupid}
Only the teacher of this course and assistants of this course should be able to perform this action

Request

Path Params
groupid
string 
required
Query Params
name
string 
optional

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://prod.your-api-server.com/groups/?name'

Responses

🟢200Success
application/json
Body
groupId
string 
required
name
string 
required
capacity
number 
required
groupclusterUrl
string 
required
members
array [object {4}] 
required
name
string 
required
email
string 
required
userId
number 
required
studentNumber
number 
optional
Example
{
  "groupId": "string",
  "name": "string",
  "capacity": 0,
  "groupclusterUrl": "string",
  "members": [
    {
      "name": "string",
      "email": "string",
      "userId": 0,
      "studentNumber": 0
    }
  ]
}
Previous
Update an existing group
Next
Update project score for an existing group
Built with