v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Create Membership Invitation

Creates a new membership invitation and notifies the invited user via email.

post/sites/multiscreen/{site_name}/membership/invitations

Path parameters

site_namestring required

The unique identifier of the target site.

Request body

emailstring

Email of the user to invite to the site. This email will be notified about the invitation to join the site. User should log in to the site with this email to be added to the groups.

Response

200

createdstring

emailstring

idstring

Example response

{
  "created": "2024-08-01T00:00:00Z",
  "email": "user-email@example.com",
  "groups": [
    {
      "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e",
      "name": "Premium users"
    }
  ],
  "id": "5f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e"
}