---
title: "Create tenant invite"
method: POST
path: "/resources/tenants/invites/v1"
tags: ["Account invitations settings"]
---

# Create tenant invite

`POST /resources/tenants/invites/v1`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/tenants/invites/v1`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/tenants/invites/v1/post.ts> (a function with typed inputs; its response is checked against the schema)

This route creates a general invitation token. To create an invitation token for a specific tenant, send the tenant’s ID in the request’s body. To create an invitation token for a specific user of a tenant, you can add the user ID on the body params. If a user ID was provided, you can decide wether to send an email to the user or not via the shouldSendEmail param. In order to set up a specific expiration time, use the expiresInMinutes to declare when the invite is being invalidated. A vendor token is required for this route, it can be obtained from the vendor authentication route.

## Request body

- CreateInviteTokenRequest
  - `tenantId` string, required
  - `userId` string
  - `expiresInMinutes` number
  - `shouldSendEmail` boolean

## Response `201`

- InviteTokenDto
  - `id` string, required
  - `vendorId` string, required
  - `tenantId` string, required
  - `userId` string
  - `token` string, required
  - `expires` string, date-time, required
  - `shouldSendEmail` boolean, required
  - `name` string

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)