---
title: "POST /v1/user-invitations"
method: POST
path: "/v1/user-invitations"
tags: ["user-invitations"]
---

# POST /v1/user-invitations

`POST /v1/user-invitations`

Send a user invitation to a user. If the user already has an invitation, the invitation will be updated.

## Request body

- union
  - object
    - `type` 'PROJECT', required
    - `email` string, required
    - `projectId` string, required
    - `projectRole` string, required
  - object
    - `type` 'PLATFORM', required
    - `email` string, required
    - `platformRole` 'ADMIN' | 'MEMBER' | 'OPERATOR', required

## Response `201`

Default Response

- object
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `email` string, required
  - `status` 'PENDING' | 'ACCEPTED', required
  - `type` 'PLATFORM' | 'PROJECT', required
  - `platformId` string, required
  - `platformRole` 'ADMIN' | 'MEMBER' | 'OPERATOR', nullable
  - `projectId` string, nullable
  - `projectRoleId` string, nullable
  - `projectRole` object, nullable
    - `id` string, required
    - `created` string, required
    - `updated` string, required
    - `name` string, required
    - `permissions` string[], required
    - `platformId` string, nullable
    - `type` string, required
    - `userCount` number
  - `link` string

---

[API](https://skmtc.dev/activepieces/apis/activepieces-documentation.md) · [All operations](https://skmtc.dev/activepieces/apis/activepieces-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/activepieces/activepieces-documentation/revisions/745e4b7f764a/schema)