---
title: "Find or Create Invite"
slug: "find-or-create-invite"
status: "update"
updated: 2026-09-15T14:02:54Z
published: 2026-09-15T14:02:54Z
canonical: "developer.rocket.chat/find-or-create-invite"
---

> ## 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.

# Find or Create Invite

Post/api/v1/findOrCreateInvite

Creates or return an existing invite with the specified parameters.

[Permission](https://docs.rocket.chat/docs/permissions) required: `create-invite-links`

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='c67eac94-35e5-4601-8b90-66dce1bbb467'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='a37f6a30-a98d-42e6-9e07-91a7a0705185'>Example</option>
</select>Example

```json
{
  "rid": "csFYrDeixJG7PnrAh",
  "days": 10,
  "maxUses": 0
}
```

object  ridstring    Required

The room ID that the invite is being created for.

daysinteger    Required

The number of days that the invite will be valid for. Send `0` for unlimited.

maxUsesinteger    Required

The number of times that the invite can be used. Send `0` for unlimited.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='260d240f-d574-435d-a271-458affa0e37b'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='e148635d-b2e4-4c70-8800-0840c204bf63'>Success</option>
</select>Success

```json
[
  {
    "_id": "kDKQ3H",
    "days": 1,
    "maxUses": 1,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:31:56.774Z",
    "expires": "2019-12-21T03:31:56.774Z",
    "uses": 1,
    "_updatedAt": "2019-12-20T03:33:40.065Z"
  },
  {
    "_id": "99ScEP",
    "days": 1,
    "maxUses": 0,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:38:20.485Z",
    "expires": "2019-12-21T03:38:20.485Z",
    "uses": 0,
    "_updatedAt": "2019-12-20T03:38:20.485Z"
  },
  {
    "_id": "Y5JKM4",
    "days": 0,
    "maxUses": 1,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:38:25.313Z",
    "expires": null,
    "uses": 1,
    "_updatedAt": "2019-12-20T03:38:40.116Z"
  }
]
```

Array of object   object  _idstring    
daysinteger    
maxUsesinteger    
ridstring    
userIdstring    
createdAtstring    
expiresstring   | null  
usesinteger    
_updatedAtstring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='41ee1589-9930-457c-ac6a-ac0bc2d23950'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='d2144a90-5b14-4ef3-8033-2c83f04f8b32'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring