Sign in

v1

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

Create a new direct chat between two users. If one already exists, then nothing will be created and the existing chat id & URL will be returned.

put/directChats

Request body

userID1string uuid required

One of the users in the direct chat

userID2string uuid required

The other user in the direct chat

Example request

{
  "userID1": "4f4fffdb-1e21-41ee-8569-2627bb7e80d2",
  "userID2": "258d5dcb-cea3-44f4-95f7-3ebe291a7142"
}

Response

Successful response

chatIDstring uuid
urlstring

A URL pointing to this direct chat

Example response

{
  "chatID": "5dbcf5c9-5e7e-4285-9dab-6d3ce7f4dd2f",
  "url": "https://app.heartbeat.chat/mycommunity/c/5dbcf5c9-5e7e-4285-9dab-6d3ce7f4dd2f"
}