---
title: "New User"
method: POST
path: "/v2/users"
tags: ["Routes", "Users"]
---

# New User

`POST /v2/users`

This request creates a new User and emails them a welcome email with details on how to access Limble.

Parameter: firstName, Type: String, Required?: Optional, Description: The User's first name.
Parameter: lastName, Type: String, Required?: Optional, Description: The User's last name.
Parameter: email, Type: string, Required?: Required, Description: The User's email address.
Parameter: password, Type: string, Required?: Optional, Description: The User's password.
Parameter: locationID, Type: Int, Required?: Required, Description: The locationID of the Location the Role will be at.
Parameter: roleID, Type: Int, Required?: Required, Description: The initial Role this user will be granted. This can be changed later with the "Add Role To User" request.
Parameter: phone, Type: string, Required?: Optional, Description: The User's phone number.
Parameter: wage, Type: number, Required?: Optional, Description: The User's wage per hour.
Parameter: workDayHours, Type: number, Required?: Optional, Description: The User's hours per day they work.
Parameter: active, Type: Boolean, Required?: Optional, Description: The User's activation status.
Parameter: emailNotificationActive, Type: Boolean, Required?: Optional, Description: The User's email notification activation status. Should they receive email notifications?
Parameter: pushNotificationActive, Type: Boolean, Required?: Optional, Description: The User's push notification activation status. Should they receive push notifications?

## Response `201`

New User

- object
  - `userID` integer

## Other responses

- `400` — The request was malformed — either invalid JSON syntax or a validation failure (missing required field, wrong type, etc.).
- `401` — No `Authorization` header was provided on the request.
- `403` — The supplied credentials are invalid, the customer account is inactive, or the credentials do not have permission to perform this action.
- `409` — The request conflicts with the current state of the resource (e.g. a uniqueness constraint or a referenced parent that is in the wrong state).
- `429` — The per-minute or per-hour rate limit for this credential and method has been exhausted. Inspect the `X-RateLimit-*` headers to determine when to retry.
- `500` — An unhandled server-side error. The body message is generic (`System unavailable...`) when the underlying cause is a database fault; otherwise it reflects the raised error.

---

[API](https://skmtc.net/limblecmms/apis/limble-api-v2.md) · [All operations](https://skmtc.net/limblecmms/apis/limble-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/limblecmms/limble-api-v2/revisions/20801e23f7f2/schema)
