---
title: "Use Invite Token"
slug: "use-invite-token"
status: "update"
updated: 2026-09-15T14:03:16Z
published: 2026-09-15T14:03:16Z
canonical: "developer.rocket.chat/use-invite-token"
---

> ## 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 | Description |
| --- | --- |
| 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='c65ea740-f2fc-45b9-b69a-5d2317569c46'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='d08a241b-6df4-4a8d-a8eb-eb1786fc94cf'>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='157f2f2c-ceb8-422e-be8f-c21a69aa1877'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='87de6579-1480-4d1a-a2e2-271014b3d75b'>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='2898a3f6-7f5f-4a8d-8f70-46f07e0de0cb'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='4524cca9-c772-4545-af84-9878d6359a20'>User Is Banned</option>
<option value='513fe59a-a311-40cb-a4ce-160a7d148060'>Invalid Token</option>
<option value='bc2fa4d8-911c-4ba0-92d6-41111a0a2454'>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='3392461d-54d0-4b54-ae6b-984f3187e8f2'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='c970e403-49e7-415d-acd0-a955d846fed4'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring