---
title: "Sends an AuthGroup invite to the given email."
method: POST
path: "/api/authgroup/invite"
tags: ["Auth Groups"]
---

# Sends an AuthGroup invite to the given email.

`POST /api/authgroup/invite`

## Request

- Base URL: `https://passivelogic.com` (the document declares no server; this is the origin it was published from)
- URL: `https://passivelogic.com/api/authgroup/invite`
- Auth: one of:
  - API key in header `X-PL-AUTH`
  - API key in header `Authorization: PL-API-KEY`
  - API key in header `PL-API-KEY`
  - HTTP basic
- TypeScript: <https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/authgroup/invite/post.ts> (a function with typed inputs; its response is checked against the schema)

Generates and sends an invitation link for the given Site or View (AuthGroup) to the given user email.

## Request body

- InviteUserToAuthGroupData: Parameters required to invite a user to an organization
  - `expiration` string, date-time, nullable: Timestamp at which this invitation will no longer be valid
  - `authGroupID` string, uuid, required: ID of the AuthGroup to which this invite pertains
  - `inviteEmail` string, required: Email to send the invite to
  - `role` 'PrivilegedUser' | 'ReadOnlyUser' | 'StandardUser' | 'SuperUser'

## Response `200`

OK

- AuthGroupInviteResponse: Response indicating that an AuthGroup invitation was successfully sent.
  - `message` string, required: Message with additional information
  - `inviteID` string, uuid, required: ID of the invitation generated/sent

---

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