nexlink/docs/api/invite.md
2025-12-26 19:24:13 +01:00

59 lines
826 B
Markdown

## GET /api/v1/invite/{id}
Returns an invite with id = {id}
### Response:
```json
{
"id": "string",
"communityId": "string",
"valid": true,
"unlimitedInvites": false,
"hasExpiration": false,
"remainingInvites": 0,
"creationDate": 0,
"expirationDate": 0
}
```
## DELETE /api/v1/invite/{id}
_Requires an authorization header_
Removes an invite with id = {id}
### Response:
```json
{
"id": "string",
"communityId": "string"
}
```
## POST /api/v1/invite/{id}/accept
_Requires an authorization header_
### Request:
```json
{
"userId": "string"
}
```
Accepts an invite and joins user to a community with id = {id}
### Response:
```json
{
"id": "string",
"userId": "string",
"userName": "string",
"communityId": "string",
"communityName": "string"
}
```