Theme switcher

Import users spreadsheet

Header Parameters

Authorizationstring

Body Parameters

import_idstring

String GUID that determines the id of the current Import summary and process. This identifier identifies each file.

email_new_usersboolean

Boolean flag that determines whether to send an email to new users or not (non existing users in the DB, but present in the spreadsheet). If not defined, it defaults to false.

update_existing_usersboolean

Boolean flag that determines whether to update existing users or not (already existing users in the DB). If not defined, it defaults to false.

delete_missing_usersboolean

Boolean flag that determines whether to delete missing users or not (users in the DB but not in the spreadsheet). If not defined, it defaults to false.

Response

202
Object

Request has been accepted

Response Attributes

client_idinteger Required

Number that determines the id of the current Client.

import_idstring Required

String GUID that determines the id of the current Import summary and process. This identifier identifies each file.

task_idstring Required

String GUID that determines the id of the celery task.

400
Object

Invalid request parameters

Response Attributes

errorstring
401
Object

Access token is missing or invalid

Response Attributes

errorstring
404
Object

Requested resource not found

Response Attributes

errorstring
500
Object

Internal/Unexpected Error

Response Attributes

errorstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?