Skip to main content
POST
Invite a member (owner/admin only)
Invites a new member to the organization via email.

Permissions

User must be owner or admin to invite members.

Invitation Flow

  1. Creates a pending invitation
  2. Publishes MemberInvitedEvent
  3. Event handler sends invitation email
  4. User receives email with invitation link
  5. User accepts invitation to join

Invitation Expiry

Invitations expire after 7 days. After expiration, a new invitation must be sent.

Example

Events Published

  • MemberInvitedEvent - Triggers invitation email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
email
string
required

Email address of the user to invite

Example:

"user@example.com"

role
enum<string>
required

Role to assign to the invited member

Available options:
admin,
member
Example:

"member"

Response

Invitation created successfully. Email sent to the invitee.