Create invitation

POST/workspaces/{organizationId}/invitations

Path parameters

organizationIdstringrequired

Request body

application/json

emailstring<email>required

rolestringrequired

teamIdstring

Responses

201

Invitation created

idstringrequired

organizationIdstringrequired

emailstringrequired

rolestringrequired

statusstringrequired

teamIdstring | nullrequired

expiresAtintegerrequired

expiredbooleanrequired

inviterIdstringrequired

createdAtintegerrequired

400

Invalid email, unknown team, or the address already belongs to a member or pending invitation

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

emailstring*rolestring*teamIdstring

Request

curl -X POST '/workspaces/string/invitations' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "role": "string",
  "teamId": "string"
}'

const response = await fetch("/workspaces/string/invitations", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"user@example.com\",\n  \"role\": \"string\",\n  \"teamId\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/invitations",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"user@example.com\",\n  \"role\": \"string\",\n  \"teamId\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "email": "string",
  "role": "string",
  "status": "string",
  "teamId": "string",
  "expiresAt": 0,
  "expired": true,
  "inviterId": "string",
  "createdAt": 0
}