---
title: "Invite a team member"
method: POST
path: "/teams/{team_id}/invite_team_member"
tags: ["Teams"]
---

# Invite a team member

`POST /teams/{team_id}/invite_team_member`

## Request

- Base URL: `https://api.convex.dev/v1`
- URL: `https://api.convex.dev/v1/teams/{team_id}/invite_team_member`
- Auth: HTTP bearer

Invite a member to the given team by email. `role` is required and must be
one of `admin`, `developer`, or `custom`. Pass `custom` together with a
non-empty `customRoles` list to invite a member into a custom role; for
`admin` and `developer`, `customRoles` must be omitted.

## Request body

- CreateInvitationArgs
  - `email` string, required
  - `role` 'admin' | 'developer' | 'custom', required
  - `customRoles` CustomRoleId[], nullable: Custom roles to attach when `role` is `custom`. Required and non-empty in that case, and forbidden otherwise.

## Response `200`

---

[API](https://skmtc.dev/convex/apis/convex-management-api.md) - [All operations](https://skmtc.dev/convex/apis/convex-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/convex/apis/convex-management-api/revisions/2ded7dd7ebcf?raw)