v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
invitations

Add users to an existing invitation

post/invitations/{invitationID}

Path parameters

invitationIDstring uuid required

The id of the invitation

Request body

emailsstring[] required

The list of emails to add to the invitation

shouldSendEmailboolean required

Whether or not to send an invitation email to the users. If false, the users will be allowed to signup via the invitation link, however they will not receive an email from Heartbeat inviting them to join.

Response

Successful response