Create workspace invitation

POST/api/v1/workspaces/{slug}/invitations/

Create a workspace invite

Path Parameters

slug:requiredstring

Workspace slug

Body Parameters

email:requiredstring

Email.

role:optionalinteger

• 20 - Admin
• 15 - Member
• 5 - Guest

Scopes

Workspace admin or owner permission required.

Create workspace invitation

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "Example Name",
  "role": 20
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "email": "Example Name",
      "role": 20
    }
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/invitations/", {
  method: "POST",
  headers: {
    "X-API-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "Example Name",
    role: 20,
  }),
});
const data = await response.json();

Response201

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "Example Name",
  "role": 20,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "responded_at": "2024-01-01T00:00:00Z",
  "accepted": true
}