Skip to main content

Type Alias: SendInvitationsRequest

type SendInvitationsRequest: components["schemas"]["SendInvitationsRequest"];

Properties

PropertyTypeRequiredDescription
participantIdsstring[]NoParticipant IDs to invite
emailsstring[]NoEmail addresses to invite
customProtocolstringNoCustom protocol format for join URL (example: "mygame://")
baseUrlstringNoBase URL for HTTP join links (example: "https://game.example.com")
invitedByIdstringYesParticipant UUID of the person sending invitations

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:29