Update workspace invitation

PATCH/api/v1/workspaces/{slug}/invitations/{pk}/

Update a workspace invite

Path Parameters

pk:requiredstring

Workspace invite ID

slug:requiredstring

Workspace slug

Body Parameters

email:optionalstring

Email.

role:optionalinteger

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

Scopes

Workspace admin or owner permission required.

Update workspace invitation

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "Example Name",
  "role": 20
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/",
    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/550e8400-e29b-41d4-a716-446655440000/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      email: "Example Name",
      role: 20,
    }),
  }
);
const data = await response.json();

Response200

{
  "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
}