- Compatible XF versions
- 2.3
Allows paid or free subscriptions with an invitation key for controlled community access.
Guests and authorized users can purchase invitation codes through the XF payment provider.
Allow users to generate free invitation keys based on permissions.
Set a limit for the creation and use of invitation keys (e.g., 1 key for X days).
Configure permissions and generate invitation keys for added flexibility.
Track the use of invitation keys to ensure transparency and governance.
Manage and create invitation keys directly from the Admin Console. See the use of invitations and purchases in the statistics.
Integrate the creation, use, and management of invitation keys with external applications.
Provide a controlled and customized invitation system for your forum!

Guests and authorized users can purchase invitation codes through the XF payment provider.
Allow users to generate free invitation keys based on permissions.
Set a limit for the creation and use of invitation keys (e.g., 1 key for X days).
Configure permissions and generate invitation keys for added flexibility.
Track the use of invitation keys to ensure transparency and governance.
Manage and create invitation keys directly from the Admin Console. See the use of invitations and purchases in the statistics.
Integrate the creation, use, and management of invitation keys with external applications.
Provide a controlled and customized invitation system for your forum!
[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
- GET registration-invite-logs/
- registration-invites
- GET registration-invites/
- POST registration-invites/
- GET registration-invites/{id}/
- POST registration-invites/{id}/
- DELETE registration-invites/{id}/
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 |









