---
title: "Create an HCM User"
method: POST
path: "/v1/user"
tags: ["Users"]
---

# Create an HCM User

`POST /v1/user`

## Request

- Base URL: `https://api.avionte.com/front-office`
- URL: `https://api.avionte.com/front-office/v1/user`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Creates an HCM User record that will allow a user to be able to log into Bold.

## Headers

- `RequestId` string, uuid: Unique request identifier in UUID format used to correlate request data to log entries and events.
- `FrontOfficeTenantId` integer
- `Tenant` string

## Request body

- HcmUser
  - `firstName` string, required: The user's first name.
  - `lastName` string, required: The user's last name.
  - `emailAddress` string, required: The user's primary email address.
  - `homePhone` string: The user's home phone number.
  - `workPhone` string: The user's work phone number.
  - `mobilePhone` string: The user's mobile phone number.
  - `faxPhone` string: The user's fax phone number.
  - `street1` string: Street address, line 1.
  - `street2` string: Street address, line 2.
  - `city` string: City.
  - `stateProvince` string: ISO 2-character code for the Province, State, or Region.
  - `postalCode` string: ZIP/postal code.
  - `country` string: A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.
  - `homeOfficeId` integer, required: The identifier of the user's home office.
  - `officeAccess` integer[]: A list of office IDs that the user has access to.
  - `userTypeId` integer, required: The identifier for the user type of the user.
  - `userGroups` integer[]: A list of user group IDs to which the user belongs.
  - `sendWelcomeEmail` boolean: An indication of whether to send a welcome email to the user upon creation. This will default to false if not provided.

## Response `201`

The HCM User that was successfully created.

- ApiUser
  - `userId` integer: The identifier for the user.
  - `firstName` string: The user's first name.
  - `lastName` string: The user's last name.
  - `emailAddress` string: The user's email address.
  - `homePhone` string: The user's home phone number.
  - `workPhone` string: The user's work phone number.
  - `mobilePhone` string: The user's mobile phone number.
  - `faxPhone` string: The user's fax phone number.
  - `address` Address
    - `street1` string: Street address, line 1.
    - `street2` string: Street address, line 2.
    - `city` string: City.
    - `state_Province` string: ISO 2-character code for the Province, State, or Region.
    - `postalCode` string: ZIP/postal code.
    - `country` string: A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.
    - `county` string: County.
    - `geoCode` string: Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.
    - `schoolDistrictCode` string: School district code based on the Geo Code.
  - `officeName` string: The name of the user's home office.
  - `officeDivision` string: The division of the user's home office.
  - `officeRegion` string: The region of the user's home office.
  - `isArchived` boolean: An indication of whether the user's record is archived or not.
  - `createdDate` string, date-time: The date when the user profile was created.
  - `lastUpdatedDate` string, date-time: The date of the most recent update to the user profile.
  - `smsPhoneNumber` string: The phone number to which SMS messages should be sent.
  - `smsForwardingNumber` string: The phone number to which SMS messages should be forwarded.
  - `userType` string: User type of the user
  - `entityId` integer: The ID of the entity associated with the user. When User Type = HCM, it is the ID of the user When User Type = Manager or Contractor, it is the ID of that entity
  - `email2` string: The second email of the user.
  - `status` 'Inactive' | 'Active'
  - `homeOfficeId` integer: The identifier of the user's home office.
  - `officeAccess` integer[]: A list of office IDs that the user has access to.
  - `userGroups` integer[]: A list of user group IDs to which the user belongs.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `406`: Unsupported format(s) indicated by Accept header
- `409`: Operation could not be completed due to conflict.
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/bold-front-office-api.md) - [All operations](https://skmtc.dev/avionte/apis/bold-front-office-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/bold-front-office-api/revisions/bd5996cbaa0f?raw)