Guests

Create a new guest

Creates guest invitations owned by the authenticated user. Without names, creates one guest: if name is omitted or empty, an auto-generated placeholder name is used. With names[], creates one guest per name (up to 500 per request) and responds with the list. groups[] tags the new guests with existing groups. Each guest carries its nine-letter access code, its direct access link and the content of its QR code.

post/v1/guests/

Request

  • Base URL: https://api.educaplay.com
  • URL: https://api.educaplay.com/v1/guests/
  • Auth: HTTP bearer

Response

Guest created. With names[], a list of the guests created.

OR

Example response

{
  "id": 12345,
  "name": "Alice",
  "code": "ABC-DEF-GHI",
  "_links": [
    {
      "rel": "self"
    }
  ],
  "link": "https://www.educaplay.com/login/invitation/ABC-DEF-GHI/",
  "qr": "https://www.educaplay.com/login/invitation/ABC-DEF-GHI/",
  "groups": [
    {
      "id": 42,
      "name": "3.º B",
      "count": 27
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.