Imports users into your organization. The import file must not exceed 100,000 rows or 30 MB in size.

Required URL parameters
modeEither Insert, UpdateOrInsert, or UpdateOrInsertOrDelete. Controls whether existing users will be updated or deactivated if they are missing in the import file.
Required form parameters
fileThe file to import as form value of the POST. Supported file formats are xlsx, xls, ods, csv, simplecsv, or xlsxtable.
importConfigThe import configuration file as form value of the POST. More information
Optional URL parameters
languageRecommended. Language used for the import. More information
delimiterIf uploading a CSV, controls which character is used as delimiter. The default is automatic, supported values are commadelimited, semicolondelimited, tabdelimited, or automatic.
encodingNameIf uploading a CSV, sets the encoding used to interpret the data. The default is automatic. Some other popular choices are utf-8, utf-16, and Windows-1252.
Example usage with curl
curl -o result.txt -u admin_username:admin_password -F file=@users.xls -F importConfig=@users.importcfg ""

Caution: If using curl, don't forget the @-sign in front of the file names

Field Description

You can import the following fields for users. See importConfig for a description on how to create the import configuration file. For the sake of clarity the fields are grouped like in the UI import. The groups themselves are only for informational purposes and have no bearing on the import configuration file.

Refreshing offline data