Overview
TheUserInvitation struct represents a pending invitation sent to a user to join the platform or organization.
Definition
Fields
Unique identifier for the invitation.
Email address of the invited user.
The role assigned to the user upon acceptance. Can be a predefined role or custom role ID.
ID of the organization the user is being invited to. If None, it’s a platform-level invitation.
ISO 8601 timestamp of when the invitation was created.
ISO 8601 timestamp of when the invitation expires. Typically 7 days from creation.
Usage Example
Related Types
- InvitationListResponse - Response containing list of invitations
- InviteUserRequest - Request to create new invitation
See Also
- invite_user - API method to send invitations
- fetch_invitations - API method to list invitations
