PATCH

https://api.neobrain.io/{version}

/
users
/
{id}

Authorizations

Authorization
string
headerrequired

API token for the Authorization header parameter.

Headers

Accept-Language
string

Language identifier, using the ISO 639-1 specification. If none provided it will use the account default language. For additional info please access /v1/locales

Path Parameters

id
string
required

Resource identifier. It can be an integer or a string having the following format x-EMPLOYEE_ID, where EMPLOYEE_ID is a alpha numerical string and is related to employeeId field value.

Body

application/json
firstName
string
required
lastName
string
required
email
string
required
employeeId
string
secondaryEmail
string | null
phone
string | null
secondaryPhone
string | null
gender
integer | null

1 is male, 2 is female

locale
string

Only accepts values available for your account. For available languges please access /v1/locales

nationality
string | null
birthDay
string | null
address
string | null
city
string | null
zipcode
string | null
country
string | null
status
boolean | null

If none provided it will default to status 1 (active)

isManager
boolean | null
managerId
string | null

User ID (can be User ID (int) or employeeID (string))

rhId
integer | null

User ID (can be User ID (int) or employeeID (string))

jobId
string | null

Job Id (can be Job ID (int) or externalId (string))

additionalFields
object[]

Response

200 - application/json
id
integer

Internal ID

employeeId
string
firstName
string
lastName
string
email
string
secondaryEmail
string
phone
string
secondaryPhone
string
gender
integer
locale
string
birthDay
string
nationality
string
address
string
city
string
zipcode
string
country
string
status
boolean | null
isManager
boolean | null
managerId
integer

Manager Internal user ID

managerEmployeeId
string

Manager Employee ID

job
object[]
additionalFields
object[]