# Upsert External Users

Upsert External Users

Endpoint: PATCH /rest/2.0/EXTERNAL_USER
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.First_Name` (string)
    First Name

  - `brmObjects.ThemeId` (integer)
    Theme

  - `brmObjects.Email` (string, required)
    Email

  - `brmObjects.AccountId` (integer, required)
    Primary Account: Account

  - `brmObjects.Last_Name` (string)
    Last Name

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.Username` (string, required)
    Username

  - `brmObjects.InternalAuthenticationDisabledFlag` (integer)
    Disable Internal Authentication: If you have SSO authentication setup, check this to prevent users from authenticating with the system using credentials stored in BP. The setting has no effect when SSO authentication is not active.

  - `brmObjects.RegionalSettings` (string)
    RegionalSettings

  - `brmObjects.ResetPasswordFlag` (integer)
    Reset Password

  - `brmObjects.Id` (string, required)
    Id: User id

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.RoleId` (integer, required)
    RoleId

  - `brmObjects.LanguageCode` (integer, required)
    LanguageCode

  - `brmObjects.TimeZoneId` (integer, required)
    TimeZoneId

  - `brmObjects.FederationId` (string)
    FederationId

  - `brmObjects.ConvertTimeZone` (integer)
    ConvertTimeZone

  - `externalIDFieldName` (string)
    Enum: "Username"

## Response 200 fields (application/json):

  - `upsertResponse` (array)

  - `upsertResponse.Id` (integer)

  - `upsertResponse.success` (boolean)

  - `upsertResponse.ErrorText` (string)

  - `upsertResponse.ErrorElementField` (string)

  - `upsertResponse.created` (boolean)