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

# POST /v1/user-invitations/

`POST /v1/user-invitations/`

## Request body

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

## Response `201`

Default Response

- object
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `email` string, required
  - `status` union, required
    - 'PENDING'
    - 'ACCEPTED'
  - `type` union, required
    - 'PLATFORM'
    - 'PROJECT'
  - `platformId` string, required
  - `platformRole` union
    - 'ADMIN'
    - 'MEMBER'
  - `projectId` string
  - `projectRole` union
    - 'ADMIN'
    - 'EDITOR'
    - 'OPERATOR'
    - 'VIEWER'

## Changes

- **2024-06-11** `a1d1c2fbc615` — 1 info
  - endpoint added
- **2023-12-03** `7b0cc60eed56` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/rantirai/apis/activepieces-documentation/changes/v1/user-invitations/post.md)

---

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