1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

CreateGroupInvitationRequestModel — openapi

Request for inviting a user to a group.

Properties

NameTypeRequiredDescription
recipientUserIdintegertrueThe user to invite.
roleIdsarrayfalseGroup role ids to grant when the invitation is accepted.

Complete Schema

{
  "required": [
    "recipientUserId"
  ],
  "type": "object",
  "properties": {
    "recipientUserId": {
      "type": "integer",
      "description": "The user to invite.",
      "format": "int64"
    },
    "roleIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "Group role ids to grant when the invitation is accepted.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Request for inviting a user to a group."
}