---
title: "Use Invite Token"
slug: "use-invite-token"
updated: 2026-06-08T12:46:40Z
published: 2026-06-08T12:46:40Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Invite Token

Post/api/v1/useInviteToken

Uses an invite token to join a channel or room.

This endpoint also checks whether the user is banned from the target room before allowing them to use the invite link. A banned user must be unbanned first before they can join via an invite token.

### Changelog

| Version | Change |
| --- | --- |
| 8.4.0 | Added ban check — banned users can no longer join via invite token |

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters<select class='api-response-data' aria-label='Media type'><option value='65da15a9-e7d4-489d-921b-839d2d025619'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='75e0352e-8ecc-4771-9644-16d50bc92fdd'>Use Invite Token</option>
</select>Use Invite Token

```json
{
  "token": "R4VDXJ9KJZB8M2QW"
}
```

object  tokenstring    Required

The invite token to use.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='59526e46-0a40-4740-8a3a-165f925b8495'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='44bbc403-08fa-43ea-8c3a-9ae3a95e7ba2'>Success Example</option>
</select>Success Example

```json
{
  "room": {
    "_id": "sN9KJZX2aX7aXqB2a",
    "name": "general",
    "topic": "General discussion"
  },
  "success": true
}
```

Expand Allobject  roomobject  

The room information.

_idstring    
namestring    
topicstring    

successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='51211a98-4828-424b-b667-e581c6a8b32f'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='bbefe615-ab9f-44fe-888f-3aad0c1e403c'>User Is Banned</option>
<option value='e0466a07-c5ed-4484-a41f-6d9c292a85b7'>Invalid Token</option>
<option value='a3fcab99-a4c3-4e5b-a89e-4bd2e52af159'>Token Expired</option>
</select>User Is Banned

```json
{
  "success": false,
  "error": "User is banned from this room",
  "errorType": "error-user-is-banned"
}
```

Invalid Token

```json
{
  "success": false,
  "error": "Invalid invite token",
  "errorType": "error-invalid-token"
}
```

Token Expired

```json
{
  "success": false,
  "error": "Invite token has expired",
  "errorType": "error-invite-token-expired"
}
```

object  successboolean    
errorstring    
errorTypestring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='bfc48349-9ae1-4611-8cc9-c1a506809fb9'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f5d5baff-1355-4419-b2f9-7fe276e2de75'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring