Create a new invitation to join the organization

v1.0.0

This method creates and sends invitation for teachers and admins.

Invitations can only be used by new Flat users or users who are not part of the organization yet.

If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property usedBy will be directly filled with the uniquer identifier of the corresponding user.

Input

{
  "type": "object",
  "description": "The parameters to create an organization invitation",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address you want to send the invitation to"
    },
    "organizationRole": {
      "type": "string",
      "description": "User's Organization Role (for Edu users only)",
      "enum": [
        "admin",
        "billing",
        "teacher",
        "user"
      ]
    }
  }
}

Output

{
  "type": "object",
  "description": "Details of an invitation to join an organization",
  "properties": {
    "customCode": {
      "type": "string",
      "description": "Enrollment code to use when joining this organization"
    },
    "email": {
      "type": "string",
      "description": "The email address this invitation was sent to"
    },
    "id": {
      "type": "string",
      "description": "The invitation unique identifier"
    },
    "invitedBy": {
      "type": "string",
      "description": "The unique identifier of the User who created this invitation"
    },
    "organization": {
      "type": "string",
      "description": "The unique identifier of the Organization owning this class"
    },
    "organizationRole": {
      "type": "string",
      "description": "User's Organization Role (for Edu users only)",
      "enum": [
        "admin",
        "billing",
        "teacher",
        "user"
      ]
    },
    "usedBy": {
      "type": "string",
      "description": "The unique identifier of the User who used this invitation"
    }
  }
}