---
title: "Invite users to tenant in bulk"
method: POST
path: "/resources/users/bulk/v1/invite"
tags: ["Users"]
---

# Invite users to tenant in bulk

`POST /resources/users/bulk/v1/invite`

## Request

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

This route enables you to invite users to tenant in bulk. Expects an array of `users`. Each entry must include a user's `email`.

## Headers

- `frontegg-tenant-id` string, required

## Request body

- UsersBulkInviteRequestDto
  - `users` UserBulkInviteRequestDto[], required
    - `email` string, email, required
    - `name` string
    - `profilePictureUrl` string
    - `password` string
    - `phoneNumber` string
    - `provider` 'local' | 'saml' | 'google' | 'github' | 'facebook' | 'microsoft' | 'scim2' | 'slack' | 'apple'
    - `metadata` string: Stringified JSON object
    - `skipInviteEmail` boolean
    - `roleIds` string[]
    - `emailMetadata` object
    - `expirationInSeconds` number: Temporary user expiration in seconds
    - `verified` boolean

## Response `202`

- TaskContext

---

[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)