---
title: "POST /api/im/teams/{id}/invite"
method: POST
path: "/api/im/teams/{id}/invite"
tags: ["Im"]
---

# POST /api/im/teams/{id}/invite

`POST /api/im/teams/{id}/invite`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/im/teams/{id}/invite`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `email` string, email, required
  - `imRole` 'admin' | 'member' | 'stakeholder': Default member.

## Response `200`

Successful response

- object
  - `id` integer, required
  - `userId` string, required
  - `imRole` 'admin' | 'member' | 'stakeholder', required
  - `invitedNewUser` boolean, required: true when a new account was created and an invitation email sent.
  - `user` object, required
    - `name` string, nullable, required
    - `email` string, nullable, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)