nexlink/docs/api/invite.md
2025-12-28 04:29:04 +01:00

794 B

GET /api/v1/invite/{id}

Returns an invite with id = {id}

Response:

{
    "id": "string",
    "communityId": "string",
    "valid": true,
    "unlimitedInvites": false,
    "hasExpiration": false,
    "totalInvites": 0,
    "remainingInvites": 0,
    "creationDate": 0,
    "expirationDate": 0
}

DELETE /api/v1/invite/{id}

Requires an authorization header

Removes an invite with id = {id}

Response:

{
    "id": "string",
    "communityId": "string"
}

GET /api/v1/invite/{id}/accept

Requires an authorization header

Accepts an invite and joins user to a community with id = {id}

Response:

{
    "id": "string",
    "userId": "string",
    "userName": "string",
    "communityId": "string",
    "communityName": "string"
}