---
title: "Create a team invitation"
method: POST
path: "/teams/{team_id}/invitations"
tags: ["Teams"]
---

# Create a team invitation

`POST /teams/{team_id}/invitations`

## Request

- Base URL: `https://app.honeybadger.io/v3`
- URL: `https://app.honeybadger.io/v3/teams/{team_id}/invitations`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/honeybadger/apis/honeybadger-api/docs/teams/:team_id/invitations/post.ts> (a function with typed inputs; its response is checked against the schema)

Invites a user to a team.

## Path parameters

- `team_id` string, required

## Request body

- TeamInvitationCreateInput: Writable team-invitation attributes
  - `email` string, email, required
  - `admin` boolean
  - `message` string, nullable: Note included in the invitation email

## Response `201`

Invitation created

- object
  - `data` TeamInvitation, required: An invitation to join a team
    - `id` string, required
    - `team_id` string, required: ID of the team
    - `email` string, required: Email address of the invitee
    - `admin` boolean, nullable: Whether the invitation grants admin privileges
    - `message` string, nullable: Optional message included with the invitation
    - `created_at` string, date-time: When the invitation was created
    - `accepted_at` string, date-time, nullable: When the invitation was accepted
    - `created_by` object, nullable: User who created the invitation
      - `id` string: ID of the user
      - `name` string, nullable: User name
      - `email` string: User email
    - `accepted_by` object, nullable: User who accepted the invitation
      - `id` string: ID of the user
      - `name` string, nullable: User name
      - `email` string: User email
  - `meta` ResponseMeta
    - `request_id` string: Unique identifier for the request, for correlating with support

## Other responses

- `401`: The credential is missing, invalid, expired or revoked (`unauthorized`), or was sent in a way v3 doesn't accept (see the examples).
- `403`: The credential isn't allowed to do this. `error.code` says why. An account or project the credential doesn't cover is 404 `not_found`, not 403.
- `404`: Resource not found
- `422`: Validation error

---

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