JSON API » people » people/import

Imports a list of persons from a CSV file under the customer that the authenticated user belongs to.

Input parameters

Requires authentication and the administrator or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
csv	String	The contents of the CSV file.	Yes
overwrite	Integer	1 to allow overwriting of existing people, 0 not to.	No	0

The email address is not required if the system is configured not to require it.

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
409	Multiple persons exist with the same email.
500	An error occurred within the server. Check the key and message fields for more details.

Data returned

The number of users created..

Example: With required parameters

http://enswitch.example.com/api/json/people/import/?auth_username=user;auth_password=password;csv=...

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":10 } }

Change history

Version	Changes
3.15	Function added.