- Compatible XF Versions
- 2.2
- 2.3
Description:
Paid registrations for new user by invitation keys.
Features:
Routes
Types
Gets the API list of registration invite usage log.
Gets the API list of registration invites.
Creates the registration invite key.
Gets the API view for registration invite.
Edits the specified registration invite key.
Deletes the specified registration invite key.
Paid registrations for new user by invitation keys.
Features:
- Purchasing invite codes by guests (if permission set for guests group)
- Purchasing invites by existing users (if permission set)
- Adding free invite keys by existing users
- Paid/Free invite key creation/purchase limits trough permissions (1 key per x days )
- Configurable invite key usage limit trough permissions
- Logging the usage of invitations
- Invite key management & creation from ACP
Table of Contents
Routes
- registration-invite-logs
- registration-invites
Types
Routes
registration-invite-logs
GET registration-invite-logs/
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 |
registration-invites
GET registration-invites/
Gets the API list of registration invites.
| Inputs | Type | Description |
|---|---|---|
| user_id | integer |
| Outputs | Type | Description |
|---|---|---|
| invites | Invite[] | |
| pagination | pagination |
POST registration-invites/
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[] |
GET registration-invites/{id}/
Gets the API view for registration invite.
| Inputs | Type | Description |
|---|---|---|
| None. |
| Outputs | Type | Description |
|---|---|---|
| invite | mixed | Invite[] |
POST registration-invites/{id}/
Edits the specified registration invite key.
| Inputs | Type | Description |
|---|---|---|
| invite_key | integer | |
| active | bool | |
| end_date | integer |
| Outputs | Type | Description |
|---|---|---|
| invite | mixed | Invite[] |
DELETE registration-invites/{id}/
Deletes the specified registration invite key.
| Inputs | Type | Description |
|---|---|---|
| None. |
| Outputs | Type | Description |
|---|---|---|
| success | true |
