Run
Process the data from the current import operation, creating the users on Rocket.Chat. It requires the current import operation state to be ready
and it changes the operation state to importing.
It will return success if the conditions to start the process are met, without waiting for the import to finish.
It requires the run-import
permission.
URL | Requires Auth | HTTP Method |
---|---|---|
|
|
|
If a user can not be imported successfully it'll be flagged but the operation will not stop.
If a user's email or username is already in use, it'll not be created.
Only the users that were imported successfully will be removed from the staging area.
Headers
Argument | Example | Required | Description |
---|---|---|---|
|
| Required | The authenticated user ID. |
|
| Required | Auth token. |
Example Call
Example Result
Success
Error
No Permission: This occurs when the authenticated user doesn't have the
run-import
permission.
Change Log
Version | Description |
---|---|
| Added |
Last updated