nexlink/docs/api/invite.md
2025-12-29 02:03:47 +01:00

835 B

GET /api/v1/invite/{id}

Returns an invite with id = {id}

Response:

{
    "id": "string",
    "communityId": "string",
    "valid": "boolean",
    "unlimitedInvites": "boolean",
    "hasExpiration": "boolean",
    "totalInvites": "number",
    "remainingInvites": "number",
    "creationDate": "number",
    "expirationDate": "number"
}

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"
}