Sign in

v1

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

Create a new pending user in a Heartbeat community. A pending user does not yet existing within the community. However, the first time they attempt to log in, they will be created as a user within the community. If this is called for a pending user that already exists, it will update the pending user. If this is called for a user that already exists within the community, it will return an error.

put/pendingUser

Request body

emailstring email required

The user's email. Must be unique to the community

namestring required

The user's full name

roleIDstring uuid required

The id of the role the user should have

groupIDsstring[]

A list of the ids of the groups that the user should belong to

profilePicturestring

A Data URI scheme in the JPG, GIF, or PNG format. Ensure you use the proper content type (image/jpeg, image/png, image/gif) that matches the image data being provided

biostring

The user's bio

Example request

{
  "email": "dmoney@scrutefarms.com",
  "name": "Dwight Schrute",
  "profilePicture": "data:image/jpeg;base64,BASE64_ENCODED_JPEG_IMAGE_DATA",
  "bio": "I'm the best salesman at Dunder Mifflin"
}

Response

Successful response

successboolean

Example response

{
  "success": true
}