---
title: "Invite someone to a team – Superbot API"
canonical_url: "https://superbot.gg/developers/teams/createTeamInvite"
summary: "Email an invite for a role below your own (default member). A pending invite to the same address is replaced. Invites expire after 7 days."
---

> Markdown of https://superbot.gg/developers/teams/createTeamInvite. Site index: /llms.txt.

# Invite someone to a team

`POST /v1/teams/{team_id}/invites`

Email an invite for a role below your own (default member). A pending invite to the same address is replaced. Invites expire after 7 days.

- Operation id: `createTeamInvite`
- Group: [Teams](https://superbot.gg/developers/teams.md)
- Auth: A caller key holding `teams:write` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `teams:write`

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `team_id` | string | required | The team id. |

## Request body

`application/json`, required.

- `email` (string, required)
- `role` (TeamRole): The caller's role in this team. One of `owner`, `admin`, `editor`, `member`.

## Response 201

The invite, already mailed.

`application/json`: TeamInvite.

- `object` (string, required): One of `team_invite`.
- `code` (string, required)
- `email` (string, required)
- `role` (TeamRole, required): The caller's role in this team. One of `owner`, `admin`, `editor`, `member`.
- `created_at` (string, required)
- `expires_at` (string)

## Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 400 | [`invalid_request`](https://superbot.gg/developers#errors-invalid_request) | The request is malformed or a parameter is invalid; `param` names the field. |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |
| 404 | [`not_found`](https://superbot.gg/developers#errors-not_found) | No such resource on this account. |

## Examples

```sh
curl -sS -X POST "https://superbot.gg/v1/teams/$TEAM_ID/invites" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"email":"user@example.com"}'
```

```js
const teamId = 'TEAM_ID';
const res = await fetch(`https://superbot.gg/v1/teams/${teamId}/invites`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"email":"user@example.com"}),
});
console.log(res.status, await res.json());
```

```python
import os
import requests

team_id = "TEAM_ID"
res = requests.request(
    "POST",
    f"https://superbot.gg/v1/teams/{team_id}/invites",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"email":"user@example.com"},
)
print(res.status_code, res.json())
```