Comment on page

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. 1.
    Create a new import operation with
  2. 2.
    Add users to the operation with import.addusers
  3. 3.
    Trigger the import process with
  4. 4.
    Check the state of the import process with import.status
Short Description
Details 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 modified 3mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.