BRbrex-com
Users

Create user

Changed on

This endpoint creates a new user as an employee without inviting them, leaving the user INACTIVE. Use it to load your team into Brex ahead of time; invite them later with Invite user, on the Dashboard, or by using auto-invite rules.

The user is assigned to legal_entity_id when provided, and to your account's default legal entity otherwise.

post/v2/users/create

Request

Headers

Idempotency-Keystring nullable

Request body

first_namestring required
last_namestring required
emailstring email required
manager_idstring nullable
department_idstring nullable
location_idstring nullable
title_idstring nullable
cost_center_idstring nullable
legal_entity_idstring nullable

The legal entity to assign the user to. Defaults to the account's default legal entity.

metadataobject nullable

The metadata or customized attributes of the user. Maximum number of entries: 100

Response

addUser 200 response

idstring required
first_namestring required

First name of the user

last_namestring required

Last name of the user

emailstring required

Email address of the user

status'INVITED' | 'ACTIVE' | 'DISABLED' | 'PENDING_ACTIVATION' | 'INACTIVE' | 'ARCHIVED'

Status of the user

manager_idstring nullable

The user id of the manager of this user

department_idstring nullable
location_idstring nullable
title_idstring nullable
cost_center_idstring nullable
legal_entity_idstring nullable
metadataobject nullable

The metadata or customized attributes of the user. Maximum number of entries: 100

remote_display_idstring nullable

Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz

Example response

{
  "custom_fields": [
    {
      "value": {
        "data": {
          "amount": 700,
          "currency": "USD"
        }
      }
    }
  ]
}

Changes