---
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'
  - `projectId` string, nullable
  - `projectRole` union
    - 'ADMIN'
    - 'EDITOR'
    - 'OPERATOR'
    - 'VIEWER'
  - `expireyInSeconds` number

## 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` 'ADMIN' | 'MEMBER', nullable
  - `projectId` string, nullable
  - `projectRole` 'ADMIN' | 'EDITOR' | 'OPERATOR' | 'VIEWER', nullable
  - `link` string

## Changes

- **2024-09-03** `b95c8c8e8262` — 1 info
  - added the new optional request property `expireyInSeconds`
- **2024-08-14** `ed47604969c3` — 5 breaking, 6 warning, 2 info
  - the response property `platformRole` became nullable for the status `201`
  - the response property `projectId` became nullable for the status `201`
  - the response property `projectRole` became nullable for the status `201`
  - the `platformRole` response's property type changed from no type to `string` for status `201`
  - …9 more
- **2024-07-04** `6067892aa453` — 4 info
  - added `subschema #1, subschema #2` to the `platformRole` response property `anyOf` list for the response status `201`
  - added `subschema #1, subschema #2, subschema #3, subschema #4` to the `projectRole` response property `anyOf` list for the response status `201`
  - removed `subschema #1, subschema #2` from the `platformRole` response property `anyOf` list for the response status `201`
  - removed `subschema #1, subschema #2` from the `projectRole` response property `anyOf` list for the response status `201`
- **2024-07-04** `719995374e3d` — 6 info
  - added the new optional request property `projectId`
  - added the optional property `link` to the response with the `201` status
  - added `subschema #1, subschema #2` to the `platformRole` response property `anyOf` list for the response status `201`
  - added `subschema #1, subschema #2` to the `projectRole` response property `anyOf` list for the response status `201`
  - …2 more
- …earlier changes not shown

[Full 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/b04deb48df4b/schema)