Skip to content
LydieDevelopers
Menu

Invite someone by email

View as Markdown
POST/v1/workspaces/{workspaceId}/invitations

Emails an invitation link (valid for 7 days). Inviting an email that already has a pending invitation sends a fresh link. Owners and admins only.

docs:write
Request
curl -X POST "https://api.lydie.co/v1/workspaces/01JCQ3TZ0WJ8K4M2X7T9R6N1PA/invitations" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com"
  }'

Path parameters

Body

  • emailstringrequired· ≤ 320 chars
  • rolestring

    One ofadminmemberguest

    Default "member"

  • teamspaceIdsstring[]· ≤ 50 items

    Teamspaces the invitee joins on accepting (not for guests).

    Default []

Response

200
{
  "id": "string",
  "workspaceId": "01JCQ3TZ0WJ8K4M2X7T9R6N1PA",
  "email": "ada@example.com",
  "role": "owner",
  "status": "pending",
  "expiresAt": "2026-11-12T09:30:00.000Z",
  "documentId": null,
  "documentLevel": null,
  "teamspaceIds": [
    "string"
  ],
  "invitedBy": null,
  "createdAt": "2026-11-12T09:30:00.000Z"
}

Errors use one envelope for every endpoint. See Errors and versions.