Sign in

v1

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

Create a new user in a Heartbeat community

put/users

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

statusstring

The user's status

linkedinstring

A link to the user's LinkedIn profile

twitterstring

A link to the user's Twitter profile

instagramstring

A link to the user's Instagram profile

createIntroductionThreadboolean

If true and a value for bio is provided, an introduction thread for the user will be created in the channel designated for introductions in your community settings. The introduction thread will include 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",
  "status": "Trying to get promoted to Assistant Regional Manager",
  "linkedin": "https://www.linkedin.com/in/dwight-schrute/",
  "twitter": "https://twitter.com/dwight_schrute",
  "instagram": "https://www.instagram.com/dwightschrute/"
}

Response

Successful response