Invite a person by address
POST
/v1/organisations/{id}/invitationsOperation organisations.invite · since 2026-11-05 · stable
Needs a session withwritescopeAnswers201 Created
The invitation, with its expiry (14 days).
Path parameters
- idstring (uuid)required
- The organisation id.
Body (JSON)
- emailstring (email)required
- The address to invite. They accept with the same confirmed address.
- rolestringoptional
- "admin", "member" or "billing" (default member). Only an owner invites as billing.
Errors
Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer.
POST/v1/organisations/{id}/invitations
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/invitations" \
-H "Authorization: Bearer $RYKLOUD_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "sam@example.com",
"role": "member"
}'With the rykloud CLI
rykloud orgs invite [ORG] EMAIL [flags]Command reference: rykloud orgs invite