POST
/
users
curl --request POST \
  --url https://api.neobrain.io/{version}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "employeeId": "ABC12345",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "secondaryEmail": "john2@example.com",
  "phone": "+33 6 12 34 56 78",
  "secondaryPhone": "+33 6 12 34 56 78",
  "gender": 1,
  "locale": "fr",
  "nationality": "FR",
  "birthDay": "2007-06-23",
  "address": "16 Rue de Triomphe",
  "city": "Paris",
  "zipcode": 75015,
  "country": "France",
  "status": 1,
  "isManager": 1,
  "managerId": "ABC12345",
  "rhId": "ABC12345",
  "jobId": "ABC12345",
  "additionalFields": [
    {
      "externalFieldId": "external_field_code",
      "value": "Technical team"
    }
  ]
}'
{
  "id": 0,
  "employeeId": "ABC12345",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "secondaryEmail": "john2@example.com",
  "phone": "+33 6 12 34 56 78",
  "secondaryPhone": "+33 6 12 34 56 78",
  "gender": 1,
  "locale": "fr",
  "birthDay": "2007-06-23",
  "nationality": "FR",
  "address": "16 Rue de Triomphe",
  "city": "Paris",
  "zipcode": 75015,
  "country": "France",
  "status": 1,
  "isManager": 1,
  "managerId": 123,
  "managerEmployeeId": "ABC0000",
  "job": [
    {
      "id": 0,
      "externalId": "ABC",
      "title": "Java Developer"
    }
  ],
  "additionalFields": [
    {
      "externalFieldId": "external_field_code",
      "name": "Field Name",
      "value": "2007-06-23"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API token for the Authorization header parameter.

Body

application/json
​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Doe"

​
email
string
required
Example:

"john@example.com"

​
employeeId
string
Example:

"ABC12345"

​
secondaryEmail
string | null
Example:

"john2@example.com"

​
phone
string | null
Example:

"+33 6 12 34 56 78"

​
secondaryPhone
string | null
Example:

"+33 6 12 34 56 78"

​
gender
integer | null

1 is male, 2 is female

Example:

1

​
locale
string

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

Example:

"fr"

​
nationality
string | null
Example:

"FR"

​
birthDay
string | null
Example:

"2007-06-23"

​
address
string | null
Example:

"16 Rue de Triomphe"

​
city
string | null
Example:

"Paris"

​
zipcode
string | null
Example:

75015

​
country
string | null
Example:

"France"

​
status
boolean | null

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

Example:

1

​
isManager
boolean | null
Example:

1

​
managerId
string | null

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

Example:

"ABC12345"

​
rhId
integer | null

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

Example:

"ABC12345"

​
jobId
string | null

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

Example:

"ABC12345"

​
additionalFields
object[]

Not providing any field reference (eg. fieldId and/or externalFieldId) or no match is made from the provided field reference(s), it will attempt to create a new additional field based on the attributes given.

Response

201
application/json
Success
​
id
integer

Internal ID

Example:

0

​
employeeId
string
Example:

"ABC12345"

​
firstName
string
Example:

"John"

​
lastName
string
Example:

"Doe"

​
email
string
Example:

"john@example.com"

​
secondaryEmail
string
Example:

"john2@example.com"

​
phone
string
Example:

"+33 6 12 34 56 78"

​
secondaryPhone
string
Example:

"+33 6 12 34 56 78"

​
gender
integer
Example:

1

​
locale
string
Example:

"fr"

​
birthDay
string
Example:

"2007-06-23"

​
nationality
string
Example:

"FR"

​
address
string
Example:

"16 Rue de Triomphe"

​
city
string
Example:

"Paris"

​
zipcode
string
Example:

75015

​
country
string
Example:

"France"

​
status
boolean | null
Example:

1

​
isManager
boolean | null
Example:

1

​
managerId
integer

Manager Internal user ID

Example:

123

​
managerEmployeeId
string

Manager Employee ID

Example:

"ABC0000"

​
job
object[]
​
additionalFields
object[]