![[XB] Registration Invites](/data/resource_icons/0/29.jpg?1768674996){kind=icon}
- Compatible XF 2.x versions
- 2.3
Enable paid or free registrations with invite keys for controlled community access.
Offer a controlled and customizable invitation system for your forum.
Invite Code Purchases
Guests and users with permission can purchase invite codes via XF payment providers.
Free Invite Keys
Allow users to generate free invite keys based on permissions.
Usage Limits
Set limits on invite key creation and usage (for example, 1 key per X days).
Permission Controls
Configure invite key usage and creation permissions for added flexibility.
Detailed Logging
Track invite key usage for transparency and easier management.
ACP Management and Statistics
Manage and create invite keys directly from the Admin Control Panel.
View invite usage and purchases in statistics.
REST API Support
Integrate invite key creation, usage, and management with external applications.
Private & Invite-Only Communities
Maintain full control over who can register.
Commercial Forums
Sell access through paid invite keys.
Soft Launches & Beta Access
Limit registrations during early or testing phases.
Referral-Based Growth
Allow registrations only via member invitations.
Anti-Spam Protection
Reduce bot registrations and unwanted signups.
[H1]Table of Contents[/H1]
Routes
Types
[H1]Routes[/H1]
[H2]registration-invite-logs[/H2]
[H3]GET registration-invite-logs/[/H3]
Gets the API list of registration invite usage log.
[H2]registration-invites[/H2]
[H3]GET registration-invites/[/H3]
Gets the API list of registration invites.
[H3]POST registration-invites/[/H3]
Creates the registration invite key.
[H3]GET registration-invites/{id}/[/H3]
Gets the API view for registration invite.
[H3]POST registration-invites/{id}/[/H3]
Edits the specified registration invite key.
[H3]DELETE registration-invites/{id}/[/H3]
Deletes the specified registration invite key.
Routes
- registration-invite-logs
- registration-invites
Types
[H1]Routes[/H1]
[H2]registration-invite-logs[/H2]
[H3]GET registration-invite-logs/[/H3]
Gets the API list of registration invite usage log.
| Inputs | Type | Description |
|---|---|---|
| invite_id | integer | |
| user_id | integer | |
| invite_user_id | integer |
| Outputs | Type | Description |
|---|---|---|
| logs | Log[] | |
| pagination | pagination |
[H2]registration-invites[/H2]
[H3]GET registration-invites/[/H3]
Gets the API list of registration invites.
| Inputs | Type | Description |
|---|---|---|
| user_id | integer |
| Outputs | Type | Description |
|---|---|---|
| invites | Invite[] | |
| pagination | pagination |
[H3]POST registration-invites/[/H3]
Creates the registration invite key.
| Inputs | Type | Description |
|---|---|---|
| invite_key | integer | [req] |
| active | bool | [req] |
| end_date | integer | [req] |
| Outputs | Type | Description |
|---|---|---|
| invite | mixed | Invite[] |
[H3]GET registration-invites/{id}/[/H3]
Gets the API view for registration invite.
| Inputs | Type | Description |
|---|---|---|
| None. |
| Outputs | Type | Description |
|---|---|---|
| invite | mixed | Invite[] |
[H3]POST registration-invites/{id}/[/H3]
Edits the specified registration invite key.
| Inputs | Type | Description |
|---|---|---|
| invite_key | integer | |
| active | bool | |
| end_date | integer |
| Outputs | Type | Description |
|---|---|---|
| invite | mixed | Invite[] |
[H3]DELETE registration-invites/{id}/[/H3]
Deletes the specified registration invite key.
| Inputs | Type | Description |
|---|---|---|
| None. |
| Outputs | Type | Description |
|---|---|---|
| success | true |
Screenshots:
