Run Import Operation
- Print
- DarkLight
- PDF
Run Import Operation
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/import.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. Permission required: run-import
- 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 will not be created.
- Only the users that were imported successfully will be removed from the staging area.
Changelog
| Version | Description |
|---|---|
| 6.3.0 | Added |
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200
OK
Success
{
"success": true
}object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string
Was this article helpful?