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

Import Users

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	Customer ID	integer	Required
countryId		integer	None.
defaultPortalId		integer	None.

Body Parameters

List of users to import

Name	Description	Type	Additional 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.

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
  },
  {
    "firstName": "sample string 1",
    "surname": "sample string 2",
    "email": "sample string 3",
    "salaryNumber": "sample string 4",
    "gender": 0
  }
]

Response Information

Name	Type	Additional information
TotalCount	integer	None.
Errors	integer	None.
Success	integer	None.
ErrorDetails	Collection of ErrorDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "errors": 2,
  "success": 3,
  "errorDetails": [
    {
      "message": "sample string 1"
    },
    {
      "message": "sample string 1"
    }
  ]
}