invitations

Create shareable invitation link

Legacy: mints a new one-off link on every call (default and maximum expiry 168 hours, unlimited uses unless maxUses is set). Prefer POST /invitations/groups/:groupId/link, the group's reusable link.

post/invitations/groups/{groupId}/invite-link

Request

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

Path parameters

groupIdstring required

Group UUID

Request body

expiresInHoursnumber

Hours until the link expires. Defaults to 168 (7 days), which is also the maximum.

maxUsesnumber

Maximum allowed uses for the link

Example request

{
  "expiresInHours": 168,
  "maxUses": 10
}

Response

Shareable link created successfully

successboolean
messagestring

Example response

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

Changes

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