---
title: "Invite a member"
method: POST
path: "/v1/team/invitations"
tags: ["Team"]
---

# Invite a member

`POST /v1/team/invitations`

## Request

- Base URL: `https://api.upcheck.so`
- URL: `https://api.upcheck.so/v1/team/invitations`
- Auth: HTTP bearer

Records a pending invitation and returns the link that accepts it. Upcheck does not email it; send the link yourself. Invitations expire after seven days.

## Request body

- object
  - `email` string, email, required
  - `role` 'admin' | 'member'

## Response `201`

The invitation and its accept link.

- object
  - `id` string, required: Opaque identifier.
  - `acceptUrl` string, required: Send this to the invitee; opening it joins the organization.

## Other responses

- `400`: The request body or parameters are invalid. `error` names the first problem.
- `401`: The API key is missing, invalid, or revoked.
- `403`: The key's role does not allow this action.
- `429`: The key's rate limit was exceeded. Honour `Retry-After`.

---

[API](https://skmtc.dev/upcheck/apis/upcheck-api.md) · [All operations](https://skmtc.dev/upcheck/apis/upcheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upcheck/apis/upcheck-api/revisions/56f55512eb8a?raw)