---
title: "Send Invitation"
method: POST
path: "/api/invitation"
tags: ["Invitation"]
---

# Send Invitation

`POST /api/invitation`

Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

## Headers

- `TR-Organization` string, uuid, required

## Request body

- InvitationData
  - `app_url` string, required — The url of the app that the user will be directed to in order to set their password. Usually admin.trieve.ai, but may differ for local dev or self-hosted setups.
  - `email` string, required — The email of the user to invite. Must be a valid email as they will be sent an email to register.
  - `redirect_uri` string, required — The url that the user will be redirected to after setting their password.
  - `scopes` string[], nullable — The api route scopes the user will have in the organization.
  - `user_role` integer, required — The role the user will have in the organization. 0 = User, 1 = Admin, 2 = Owner.

## Response `204`

Ok response. Indicates that invitation email was sent correctly.

## Other responses

- `400` — Invalid email or some other error

---

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