Bulk update users from CSV
POST
https://sgtr-integration.returning.ai/apis/v1/users/bulk-update
Bulk Operations
What this endpoint does
Email.200 means the job was accepted. It is not proof that rows applied. The body has no job id. Use a unique log_name, then list jobs and poll status.INFO
POST /v1/users/bulk-update → GET /v1/users/bulk-update and match name → poll status until Completed → read details.Quick start
data plus log_name. Optional currency_cap is a boolean query/form flag on the CSV path.Authentication and permission
Authorization: Bearer <COMMUNITY_API_KEY>. Required permission: bulkUpdateUser. Keep the key server-side.Complete examples
message is Bulk update user process is queued. Envelope { status: "success", message, data: { message } }. No job id.Either a CSV file or JSON data must be provided.JSON data must be an array.JSON data array cannot be empty.log_name as synthetic. Do not queue jobs against live members from documentation.Success and readback
200 on accept. Readback is list jobs matching name to log_name, then status until Completed, then details.POST /v1/users/info can mask first and last name, so it is a weak readback for profile-name columns.CHECK
Completed can still describe the original payload.Errors and recovery
| Status | When | Recovery |
|---|---|---|
400 Either a CSV file or JSON data must be provided | No file and no data | Send multipart CSV or a JSON array. |
400 JSON data must be an array | data is an object | Send an array of rows. |
400 JSON data array cannot be empty | data: [] | Include at least one row. |
400 Uploaded file must be a CSV | Non-CSV multipart | Upload CSV. |
401 | Missing or invalid token | Add a valid community key with bulkUpdateUser. |
Retry safety
WARNING
log_name before posting the same file again. Duplicate POSTs create additional jobs. There is no idempotency key.Gotchas
Email, not username, Mongo _id, or numeric userId.Role replaces the community role set. It is not admin userlist Role_op=subtract._op (add, subtract, overwrite) where documented.Next steps
Request
Header Params
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-integration.returning.ai/apis/v1/users/bulk-update' \
--header 'Authorization: Bearer 0f1945a89000bfa4a58c099299ccc8c82dc733ec5f752ec44bf0548b8e59b417' \
--form 'data=@"/Users/dennykate/Downloads/bulk-update-10 (4).csv"' \
--form 'log_name="CS - >5.1k User"'Response Response Example
200 - Success Example
{
"status": "success",
"message": "Bulk update user process is queued",
"data": {
"message": "Bulk update user process is queued. You can check in Api Log ( community settings )"
}
}Modified at 2026-08-19 13:43:18