---
title: "Create an invitation"
method: POST
path: "/v1/invitations"
tags: ["Invitations"]
---

# Create an invitation

`POST /v1/invitations`

This endpoint allows you to send an invitation to a user.

If you are using a personal access token, you need to have an access level superior or equal to `member`.

## Query parameters

- `send_email` boolean

## Request body

- object
  - `email` string, required — email of the user to invite.
  - `role` 'manager' | 'member' | 'restricted' — Use `access_level` instead.
  - `access_level` 'manager' | 'member' | 'restricted'

## Response `201`

Invitation sent

- object
  - `id` integer
  - `email` string, email
  - `role` 'manager' | 'member' | 'restricted'
  - `access_level` 'manager' | 'member' | 'restricted'
  - `date` string, date-time — Creation date of the invitation

## Other responses

- `400` — Invalid data
- `401` — Invalid API key
- `403` — Forbidden Call
- `409` — Data conflict
- `503` — API under maintenance

---

[API](https://skmtc.net/gitguardian/apis/gitguardian-api.md) · [All operations](https://skmtc.net/gitguardian/apis/gitguardian-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitguardian/gitguardian-api/revisions/511b067cdcb1/schema)