Skip to main content
POST
/
organizations
/
{id}
/
members
/
invite
Invite a member (owner/admin only)
curl --request POST \
  --url http://sandbox.mintlify.com/organizations/{id}/members/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "role": "member"
}
'
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

curl -X POST http://localhost:3001/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/invite \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "role": "member"
  }'

​
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.