---
title: "Invite user"
method: POST
path: "/v2/users"
tags: ["Users"]
---

# Invite user

`POST /v2/users`

This endpoint invites a new user as an employee.
To update user's role, check out [this article](https://support.brex.com/how-do-i-change-another-user-s-role/).

## Headers

- `Idempotency-Key` string, nullable

## Request body

- CreateUserRequest
  - `first_name` string, required
  - `last_name` string, required
  - `email` string, email, required
  - `manager_id` string, nullable
  - `department_id` string, nullable
  - `location_id` string, nullable
  - `title_id` string, nullable
  - `metadata` object, nullable — The metadata or customized attributes of the user. Maximum number of entries: 100

## Response `200`

createUser 200 response

- UserResponse
  - `id` string, required
  - `first_name` string, required — First name of the user
  - `last_name` string, required — Last name of the user
  - `email` string, required — Email address of the user
  - `status` 'INVITED' | 'ACTIVE' | 'CLOSED' | 'DISABLED' | 'DELETED' | 'PENDING_ACTIVATION' | 'INACTIVE' | 'ARCHIVED' — Status of the user
  - `manager_id` string, nullable — The user id of the manager of this user
  - `department_id` string, nullable
  - `location_id` string, nullable
  - `title_id` string, nullable
  - `metadata` object, nullable — The metadata or customized attributes of the user. Maximum number of entries: 100
  - `remote_display_id` string, nullable — Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz

---

[API](https://skmtc.net/brex-com/apis/team-api.md) · [All operations](https://skmtc.net/brex-com/apis/team-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brex-com/team-api/revisions/58e231ca118e/schema)