Invitations API

Batch create invitations

Creates multiple invitations in a single request. Has a custom rate-limit of 10 calls per minute.

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

Request

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

Path parameters

site_namestring required

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

Request body

Example request

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

Response

OK

Example response

{
  "invitations": [
    {
      "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.