---
title: "Invite new user(s)"
method: POST
path: "/api/user_invite"
tags: ["Users"]
---

# Invite new user(s)

`POST /api/user_invite`

Creates one or more invitations for new users to register with a given privilege.
Requires `admin` privileges or the `create_user` permission.

## Request body

- object
  - `email_addresses` union, required — One or more e-mail addresses to invite.
    - string, email
    - string[]
  - `privilege` string — Privilege to assign to the invited user(s).
  - `send_emails` 0 | 1 — Set to 0 to suppress invitation e-mails.

## Response `200`

Invitations processed.

- object[]
  - `email` string
  - `invitation_sent` boolean
  - `url` string

## Other responses

- `400` — Bad request.
- `403` — Access denied.

---

[API](https://skmtc.dev/docassemble/apis/docassemble-api.md) · [All operations](https://skmtc.dev/docassemble/apis/docassemble-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/docassemble/docassemble-api/revisions/a75d7eea6826/schema)
