v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
Groups

Create group

Create a group and add the authenticated user as owner. name is required.

post/api/v1/groups/create/

Response

The request succeeded and returned group details.

successboolean

Example response

{
  "success": true,
  "data": {
    "id": 100,
    "status": 1,
    "name": "Test group",
    "contact": "John Doe email <example@example.com>",
    "additional_information": "At trial period",
    "created_at": 1512638171000,
    "updated_at": 1512638171000,
    "current_user_role": 3,
    "balance_type": 1,
    "max_members": 100,
    "cur_members": 65,
    "ai_checks_enabled": true,
    "teachers": 3,
    "students": 25,
    "owners": 1,
    "sale_status": 2,
    "expired_at": 1577840461000,
    "api_token": "G-test",
    "show_lti_instructions": true,
    "show_lti_grading": true,
    "created_by_user": {
      "id": 3132945,
      "name": "John Doe",
      "email": "student@example.com",
      "created_at": 1512638171000,
      "updated_at": 1512638171000,
      "allowed_languages": [
        "en"
      ],
      "balance_type": 1,
      "avatar": "https://randomuser.me/api/portraits/lego/1.jpg",
      "is_email_verification_needed": true
    }
  }
}