index/interfaces/CreateModeratorInviteOptions.md

Options for creating a new moderator invite.

Example

// Create TOKEN scope invite (access to specific token)
const tokenInvite: CreateModeratorInviteOptions = {
  tokenName: 'mytoken',
  role: 'MODERATOR',
  description: 'John - Friday evening shows',
  expiresAt: '2025-12-31T23:59:59Z'
};

// Create ALL_OWNER_TOKENS scope invite (blanket access)
const blanketInvite: CreateModeratorInviteOptions = {
  inviteScope: 'ALL_OWNER_TOKENS',
  role: 'MANAGER',
  description: 'Studio team - all tokens'
};

Properties

Property	Type	Description
description?	string	Optional description/label for the invite. Max 255 characters. Useful for tracking: "John - Friday shows"
expiresAt?	string	Optional expiration date in ISO 8601 format. If not provided, invite never expires. Example "2025-12-31T23:59:59Z"
inviteScope?	InviteScope	Scope of the invite. - TOKEN: Access to specific token only (tokenName required) - ALL_OWNER_TOKENS: Blanket access to all owner's tokens (tokenName should be omitted) Default 'TOKEN' Since 5.8.0
role	ModeratorRole	Role to grant to the moderator. Required.
tokenName?	string	Token name to grant moderator access to. Required when inviteScope is 'TOKEN' (default). Should be omitted when inviteScope is 'ALL_OWNER_TOKENS'. Must be a token owned by the authenticated user.