The Bulk User Operations API enables you to add, update, and export large numbers of users in Avaya Infinity™ using .xlsx file uploads. Each operation triggers an asynchronous job that can be monitored via the Jobs API. Download the bulk template first to ensure your file is correctly formatted before submitting.
For managing individual users, see the User Management API Reference.
Endpoints
Download Bulk Template
GET /users/bulk-template
Download the bulk operation template as an .xlsx file. The template includes the required column structure for bulk add and update operations: Email, Account Hierarchy, Last Name, First Name, Display Name, Password, Profile, Roles, Member Of, and Owned Groups.
Bulk Add Users
POST /users:bulk-add
Add multiple users in a single operation by uploading a completed .xlsx template file. Triggers an asynchronous job — monitor progress using the job ID returned in the response. The jobName must be unique; duplicate job names return 409 Conflict.
Bulk Update Users
POST /users:bulk-update
Update multiple existing users in a single operation by uploading a completed .xlsx template file. Triggers an asynchronous job — monitor progress using the job ID returned in the response.
Bulk Export Users
POST /users:bulk-export
Export the full list of users for an account. Optionally scope the export to a specific folder and all its subfolders by providing a folderId. Triggers an asynchronous job — once complete, download the exported file using GET /jobs/{jobId}/exported-users.
Getting Started
Start by downloading the bulk template to ensure your file matches the required format. Populate the template and submit it via Bulk Add Users or Bulk Update Users. Each operation returns a job ID — use the Jobs API to monitor the status of your job and retrieve per-user results once processing is complete.