Create User Group

This request is used to create a new user group within an EdApp account.

POST
https://rest.edapp.com/v2/usergroups

Request fields

Field Description  Data Type
name

User group name

string

invite code

Invite codes are used in EdApp as a means for learner registration. A user group invite code allows users to register themselves on the learners’ app with a code which will create their user in the system and automatically assign them to the user group that they used the invite code for.

string 

 

Request example

{
"name": "string",
"inviteCode": "string"
}

Response

Field Description  Data Type
id

Ed User Group Id

string
name

User Group name

string

inviteCode

Invite codes are used in EdApp as a means for learner registration. A user group invite code allows users to register themselves on the learners’ app with a code which will create their user in the system and automatically assign them to the user group that they used the invite code for.

string
users

Array of ID’s of users who are assigned to this user group

Array
courses

Array of ID’s of courses that are accessible to this user group, does not include courses that are accessible to all user groups.

Array 

 

Response Example

{
"id": "string",
"name": "string",
"inviteCode": "string",
"users": [
"string"
],
"courses": [
"string"
]
}