Send feedback
Bulk user management API
Stay organized with collections
Save and categorize content based on your preferences.
Bulk User Management API lets you use the contents of a json file
to create or modify several users in one operation.
There is no limit to the number of records that can be uploaded, but it
is recommended that requests are performed in smaller batches.
This process can also be performed in the CCAI Platform portal by following the
instructions in the Bulk user management .
Roles and permissions
Use the Apps API by creating an api_user.
The api_user does not have roles and permissions, so all api_users
can perform bulk_user management.
You cannot set granular permissions when utilizing api_user, so the
api_user will have access to all user fields.
Add an API credential
In the CCAI Platform portal, go to Settings > Developer Settings > API
Credential management .
Click + Add API Credential . An Add API Credential
message will open.
Enter a Name for the credential.
Click Create .
Bulk User Management API is a 2 step process
Upload a json file.
Request processing.
Upload the json file
Usage
Upload the json file
URL
apps/api/v1/bulk/users/upload
Method
POST / PUT
Request
content-type: multipart/form-data
{
"id" : {job_id} #optional. Required in case of PUT method.
"file": {json file}
}
Response
Header:
Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345Body
{
"id": 12345, # job_id
"status": "created"
"link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"
}
Retrieve json template (if necessary)
Usage
Template
URL
apps/api/v1/bulk/users/template
Method
GET
Request
(Empty)
Response
1[
2 {
3 "email":"user1@yourcompany.co",
4 "new_email":user1@yourcompany.cx",
5 "agent_number":"A-001",
6 "first_name":"John",
7 "last_name":"aa",
8 "status":"Active",
9 "location":"Mexico",
10 "max_chat_limit":2,
11 "max_chat_limit_enabled":0,
12 "roles": [
13 {"name":"Admin","value": 0 },
14 {"name":"Manager","value": 1 },
15 {"name":"Agent","value": 0 },
16 {"name":Developer","value": 1 }
17 ]
18 },
19 ...
20]
Request processing of the current json file
Usage
Request processing of current json file
URL
/v1/bulk/users/proceed
Method
POST
Request
1 {
2 "id": 12345 # job_id
3 }
Response
Header:
1 Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345Body
1{2 "id": 12345 # job_id3 "status": "valid_scheme",4 "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"5}
Get a status check
Usage
Get a status check
URL
apps/api/v1/bulk/users/jobs/#{job_id}
Method
GET
Request
Path variable - job_id
Response
{
"id": 12345,
"created_at": "2022-01-07T06:40:34.000Z",
"process_requested_at": "2022-01-07T06:45:34.000Z",
"filename": "100row.json",
"total_rows": 100,
"affected_rows": 52,
"failed_rows": 0,
"status": "in_progress",
"uploaded_user_name": null,
"proceed_user_name": null,
"uploaded_api_user_name": "api_user_name_1",
"proceed_api_user_name": "api_user_name_2",
"scheme_errors": []
"update_errors": []
}
Retrieve updated job list
Usage
Get update job list
URL
apps/api/v1/bulk/users/jobs
Method
GET
Request
{
"page": 1,
"per_page": 20
}
Response
Header
Link: <next link>
Total: 12345
Per-Page: 201Body
[
{
"id": 12345,
"created_at": "2022-01-07T06:21:10.000Z",
"process_requested_at": "2022-01-07T06:22:25.000Z",
"filename": "100row.json",
"total_rows": 100,
"affected_rows": 52,
"failed_rows": 0,
"status": "in_progress",
"uploaded_user_name": null,
"proceed_user_name": null,
"uploaded_api_user_name": "api_user_name_1",
"proceed_api_user_name": "api_user_name_2",
"scheme_errors": [],
"update_errors": []
},
...
]
Note
The output is sorted in reverse order of job_id so that the most
recent data comes first.
Retrieve scheme error logs
Usage
Get scheme error logs
URL
/v1/bulk/users/errors/scheme/#{job_id}
Method
GET
Request
Path variable - job_id
Response
content-type: application/json
[
{
"message": "Must be a valid email",
"column": 1,
"row": null
},
{
"message": "Non-empty string",
"column": 10,
"row": 10
}
]
Retrieve errors
Usage
Get update error logs
URL
/v1/bulk/users/errors/update/#{job_id}
Method
GET
Request
Path variable - job_id
Response
content-type: application/json
1[2 {3 "message": "Must be a valid email",4 "column": 1,5 "row": null,6 "error_type": "warning"7 },8 {9 "message": "Non-empty string",10 "column": 10,11 "row": 10,12 "error_type": "error"13 } 14]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[[["The Bulk User Management API allows for the creation or modification of multiple users simultaneously using a JSON file, though smaller batches are recommended."],["API users created via the Apps API can utilize the Bulk User Management feature without specific roles or permissions, granting them access to all user fields."],["The Bulk User Management API process is a two-step process: first, upload a JSON file using either POST or PUT method, and second, request the processing of that file via POST."],["You can retrieve a JSON template, check the status of a job, and get a list of updated jobs, in addition to retrieving scheme error logs or update error logs."],["The API endpoints and methods are provided to upload files (POST/PUT), request processing (POST), get status (GET), retrieve updated job list (GET), get scheme error logs (GET), and get update error logs (GET)."]]],[]]
