POST api/users/import?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}

Import Users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

Customer ID

integer

Required

countryId

integer

None.

defaultPortalId

integer

None.

Body Parameters

List of users to import

NameDescriptionTypeAdditional information
FirstName

First Name

string

Required

Max length: 255

Surname

Surname

string

Required

Max length: 255

Email

Email address (will be used as login)

string

Required

Max length: 512

SalaryNumber

Salary Number (if known)

string

Max length: 512

Gender

Gender

UserProfileGenderEnum

None.

DateOfBirth

Date Of Birth

date

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "firstName": "sample string 1",
    "surname": "sample string 2",
    "email": "sample string 3",
    "salaryNumber": "sample string 4",
    "gender": 0,
    "dateOfBirth": "2018-12-10T16:37:29.3324167+01:00"
  },
  {
    "firstName": "sample string 1",
    "surname": "sample string 2",
    "email": "sample string 3",
    "salaryNumber": "sample string 4",
    "gender": 0,
    "dateOfBirth": "2018-12-10T16:37:29.3324167+01:00"
  }
]

Response Information

NameDescriptionTypeAdditional information
TotalCount

integer

None.

Errors

integer

None.

Success

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "errors": 2,
  "success": 3
}