Bulk User Import Endpoints

This endpoint facilitates bulk user import. It allows you to add a payload with more than one user per request.

Workflow for importing users through the REST API

  1. Create a new import operation with import.new

  2. Add users to the operation with import.addusers

  3. Trigger the import process with import.run

  4. Check the state of the import process with import.status

UrlShort DescriptionDetails Page


Adds user data to the import staging area.


Abort any import operation currently in progress


Process the data from the current import operation and create the users on Rocket.Chat


Creates a new import operation.


Get the status of the current import operation

Last updated

Rocket.Chat versions receive support for six months after release.