mittwald API icon

mittwald API

Interact with the mittwald API

Actions125

Organisation → Create Invite

AI-generated

Summary

Create an invitation for a specified organisation by sending an invite to the provided email address with a defined role, optional membership expiry date, and an optional message.

Inputs

  • Organisation (required) — Select the organisation to which the invite will be sent, either from a list or by entering its UUID or short ID.
  • Email Address (required) — Provide the email address of the person to be invited to the organisation.
  • Role (required) — Set the role for the invitee within the organisation, choosing from Owner, Member, Accountant, or Not Set.
  • Membership Expires At — Optionally specify a date and time when the invitee's membership will expire.
  • Message — Optionally include a personal message to send along with the invitation.

Output shape

a single JSON object representing the created invite details

The output includes details of the invitation created for the specified organisation. No pagination or multiple records are returned.

Links

Discussion