Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
GroupInvitation — openapi
An invitation to join a group.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | true | The invitation id. Stringified because it can exceed the 2^53-1 JSON number limit. |
| groupId | integer | true | The group the invitation is for. |
| recipientUserId | integer | true | The invited user. |
| senderUserId | integer | true | The user who sent the invitation. |
| status | #/components/schemas/GroupInvitationStatus | true | |
| roleIds | array | true | Every group role id attached to the invitation. |
| updatedAt | string | true | When the invitation was last updated (UTC). |
Related Schemas
Complete Schema
{
"required": [
"groupId",
"id",
"recipientUserId",
"roleIds",
"senderUserId",
"status",
"updatedAt"
],
"type": "object",
"properties": {
"id": {
"minLength": 1,
"type": "string",
"description": "The invitation id. Stringified because it can exceed the 2^53-1 JSON number limit."
},
"groupId": {
"type": "integer",
"description": "The group the invitation is for.",
"format": "int64"
},
"recipientUserId": {
"type": "integer",
"description": "The invited user.",
"format": "int64"
},
"senderUserId": {
"type": "integer",
"description": "The user who sent the invitation.",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/GroupInvitationStatus"
},
"roleIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Every group role id attached to the invitation."
},
"updatedAt": {
"type": "string",
"description": "When the invitation was last updated (UTC).",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "An invitation to join a group."
}