invitations

Invite user to group

Send an email invitation to join a specific group. Any active member may invite; each person can send up to 30 email invitations per hour (429 INVITE_RATE_LIMITED beyond that).

post/invitations/groups/{groupId}/invite

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/invitations/groups/{groupId}/invite
  • Auth: HTTP bearer

Path parameters

groupIdstring required

Group UUID

Request body

emailstring required

Email address to invite to the group

Example request

{
  "email": "user@example.com"
}

Response

Invitation sent successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.