POST
/
v1
/
user-invitations
curl --request POST \
  --url https://cloud.activepieces.com/api/v1/user-invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "PROJECT",
  "email": "<string>",
  "projectId": "<string>",
  "projectRole": "<string>"
}'
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "email": "<string>",
  "status": "PENDING",
  "type": "PLATFORM",
  "platformId": "<string>",
  "platformRole": "ADMIN",
  "projectId": "<string>",
  "projectRoleId": "<string>",
  "projectRole": {
    "id": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "platformId": "<string>",
    "type": "<string>",
    "userCount": 123
  },
  "link": "<string>"
}

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
type
enum<string>
required
Available options:
PROJECT
email
string
required
projectId
string
required
projectRole
string
required

Response

201 - application/json
Default Response
id
string
required
created
string
required
updated
string
required
email
string
required
status
required
Available options:
PENDING
type
required
Available options:
PLATFORM
platformId
string
required
platformRole
enum<string> | null
Available options:
ADMIN,
MEMBER
projectId
string | null
projectRoleId
string | null
projectRole
object | null