Sign in

v1

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

Create a new invitation link within a Heartbeat community

put/invitations

Request body

roleIDstring uuid required

Members joining via this invitation link will join as this role

groupIDsstring[] required

Members joining via this invitation link will automatically be in these groups

Response

Successful response

idstring uuid

The invitation id

codestring

A 6 digit alphanumeric code included within the invitation link. Invitation links use the following format: https://app.heartbeat.chat/example/invitation?code=<CODE> OR https://example.customdomain.com/invitation?code=<CODE>

Example response

{
  "role": {
    "name": "Moderator"
  },
  "groups": [
    {
      "name": "Party Planning Committee"
    }
  ]
}