---
title: "Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup."
method: POST
path: "/api/Account/invite"
tags: ["Account"]
---

# Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

`POST /api/Account/invite`

## Request

- Base URL: `http://localhost:5000`
- URL: `http://localhost:5000/api/Account/invite`
- Auth: API key in header `x-api-key`

## Request body

- InviteUserDto
  - `email` string, required
  - `roles` string[], nullable
  - `libraries` integer[], nullable
  - `ageRestriction` AgeRestrictionDto
    - `ageRating` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1, required: Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `includeUnknowns` boolean, required

## Response `200`

OK

- InviteUserResponse
  - `emailLink` string, nullable
  - `emailSent` boolean
  - `invalidEmail` boolean

## Changes

- **2026-10-01** `1a205aa2ae6b`: 1 breaking, 9 info
  - the response's body type changed from `string` to `object` for status `200` (media type: application/json)
  - added the optional property `emailLink` to the response with the `200` status (media type: text/plain)
  - added the optional property `emailLink` to the response with the `200` status (media type: application/json)
  - added the optional property `emailLink` to the response with the `200` status (media type: text/json)
  - …6 more

[Operation history](https://skmtc.dev/kareadita/apis/kavita/changes/api/Account/invite/post.md)

---

[API](https://skmtc.dev/kareadita/apis/kavita.md) - [All operations](https://skmtc.dev/kareadita/apis/kavita/llms.txt) - [OpenAPI document](https://skmtc.dev/kareadita/apis/kavita/revisions/d266465eeb67?raw)