DUduda
Invitations API

Create invitation

Creates a new invitation and notifies the invited user by email.

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

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/invitations
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

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.

Example request

{
  "email": "user-email@example.com",
  "groups": [
    {
      "id": "15f4b3b4e-4b3b-4b3b-4b3b-4b3b4e4b3b4e"
    }
  ]
}

Response

OK

createdstring

Invitation creation ISO date-time

emailstring

Email associated with the invitation

idstring

Invitation id

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"
}

Changes

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