index/interfaces/PublicInviteInfo.md

Public invite information for the claim page. This is returned by getInviteByCode (public endpoint).

Properties

Property	Type	Description
description	string | null	Optional description/label
expiresAt	string | null	Expiration timestamp (ISO 8601) or null if never expires
invitedBy	string	Wallet address of the token owner who created the invite
inviteScope	InviteScope	Scope of the invite. - TOKEN: Access to specific token only - ALL_OWNER_TOKENS: Blanket access to all owner's tokens Since 5.8.0
role	ModeratorRole	Role to be granted
status	InviteStatus	Current status
tokenImage	string | null	Token image URL. Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
tokenName	string | null	Token name this invite grants access to. Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.
tokenSymbol	string | null	Token symbol. Present for TOKEN scope invites, null for ALL_OWNER_TOKENS scope.