---
title: "Create an invite link"
description: "Mints a link that adds whoever opens it to one app of this suite, in exactly these groups, after they sign in at the suite's address."
canonical: "https://gtable.app/docs/builder-api/invites/create"
updated: "2026-10-05"
---

# Create an invite link

`POST https://studio.gtable.app/v1/suites/{suiteId}/invites`

Mints a link that adds whoever opens it to one app of this suite, in exactly these groups, after they sign in at the suite's address.

The link is the invitation: it works even when the suite is invitation-only. It can bring a NEW person into the directory; it can never be used to set a password for an address already there, which needs that person's own link (`users.passwordLink`). Single use unless you pass `maxUses`, or `null` for unlimited. The URL is returned once and never stored in clear; copy it now.

Requires the `members:write` scope. Operation `invites.create`. MCP tool `invites_create`. CLI, once published: `gtable invites create`.

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `suiteId` | string | yes      |             |

## Headers

| Name              | Type   | Required | Description                                                                                                                                                                                                                                                        |
| ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Idempotency-Key` | string | no       | Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters. |

## Request body

| Field           | Type            | Required | Description                           |
| --------------- | --------------- | -------- | ------------------------------------- |
| `appId`         | string          | yes      | Up to 64 characters.                  |
| `groups`        | string\[]       | yes      |                                       |
| `label`         | string          | no       | Up to 120 characters.                 |
| `expiresInDays` | integer         | no       | Default `14`. At least 1. At most 90. |
| `maxUses`       | integer or null | no       |                                       |