2.1.1 GroupInvitation object

Represents an invitation to a group. Both users with an existing account and users without an account may be invited to a group. Invitees can either accept or decline the invitation.

Example

{
  "status": "ACCEPTED",
  "user": {
    "id": "x1MZEtQoRb19bU6v0bunOw",
    "emailAddress": "jane.doe@example.com"
  },
  "group": {
    "id": "bWBNGxnkf9dx2K4BGc2mndIEw0urEGKNs-9Zme3PgOM",
    "name": "European geography",
    "description": "Learn the countries and capitals of Europe",
    "counts": {
      "drillables": 20,
      "tests": 6
    }
  }
}

Fields

Field Type Description
id
optional		 String A unique ID for this group invitation. The ID is generally only used for open (non-personal) group invitations.
status
required		 String The status of the group invitation. Possible statuses are:

  • CREATED – the invitation has been created
  • INVITED – the user has been invited to the group
  • ACCEPTED – the user has accepted the invitation
  • DECLINED – the user has declined the invitation
  • CANCELLED – the invitation has been retracted and can no longer be accepted or declined
user
required		 2.1.1 User The details of the user being invited. For existing users, a user ID will be present. New users will not have a user ID, but an email address and name may be present. That information may be used to set up a new user first.
group
required		 2.1.1 Group The details of the group to which the user is being invited.
expiryDate
optional		 Date An optional expiry date for the group invitation.

 

Last updated on