---
title: "PUT /pendingUser"
method: PUT
path: "/pendingUser"
tags: ["users"]
---

# PUT /pendingUser

`PUT /pendingUser`

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.

## Request body

- object
  - `email` string, email, required — The user's email. Must be unique to the community
  - `name` string, required — The user's full name
  - `roleID` string, uuid, required — The id of the role the user should have
  - `groupIDs` string[] — A list of the ids of the groups that the user should belong to
  - `profilePicture` string — 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
  - `bio` string — The user's bio

## Response `200`

Successful response

- object
  - `success` boolean

## Other responses

- `400` — Invalid request body
- `401` — API Key is missing or invalid

---

[API](https://skmtc.net/heartbeat/apis/heartbeat-api.md) · [All operations](https://skmtc.net/heartbeat/apis/heartbeat-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heartbeat/heartbeat-api/versions/6c3cf537d508/schema)