Returning.AIDevelopers
v1

API reference / Legacy / Bulk Operations

.md

Bulk import users from CSV

Bulk import users from CSV

Last updated 26 Sep 2026API v1

Method
POST
Path
https://api.returning.ai/v1/users/bulk-import

Authentication#

Header
Authorization: Bearer <API_KEY>

Behaviour#

Legacy category

This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.

What it is for

Bulk import users from CSV.

How to use it

Send a POST request to /v1/users/bulk-import with the documented body, query parameters, headers, or multipart fields. Prefer a newer authenticated /v1/... equivalent where available.

Successful response

HTTP 2xx. Older endpoints may return a legacy response envelope or a resource-specific payload rather than the newer { status, message, data } wrapper.

Common error states
  • 400 invalid request body, query, ObjectId, pagination, file format, or missing required field.
  • 401 missing, invalid, expired, or insufficient API key/token.
  • 403 key is valid but cannot access this community/channel/user/resource, where supported by the service.
  • 404 route or target resource was not found. Several legacy root routes return 404 on https://api.returning.ai; confirm with Returning.AI before using them.
  • 409 duplicate or conflicting state for create/update operations, where applicable.
  • 500 unexpected Returning.AI service error.
Legacy status

Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current /v1/... endpoint in the matching non-Legacy category when one exists.

Request#

Headers#

Authorization#stringREQUIRED
API key.

RuleBearer <API_KEY>

Body#

data#fileOPTIONAL
CSV file only
communityId#stringOPTIONAL
Community ID for the request context.

Send the body as multipart/form-data.

curl --request POST \
  --url https://api.returning.ai/v1/users/bulk-import \
  --header 'Authorization: Bearer <API_KEY>' \
  --form 'data=@<file>' \
  --form 'communityId='

Response#

status#stringALWAYS
message#stringALWAYS
data#objectALWAYS
message#stringALWAYS
"    \"status\": \"success\",\n    \"message\": \"Bulk import user process is queued\",\n    \"data\": {\n        \"message\": \"Bulk import user process is queued. You can check in Api Log ( community settings )\"\n    }\n}"

Errors#

Fix the request02

400Fix the request
Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values.
403Fix the request
The API key is valid but is not allowed to access this community, channel, user, or resource.

Fix the data01

409Fix the data
The request conflicts with an existing resource or immutable state, such as a duplicate slug/key/name or an already-processed record.

Retry with backoff01

500Retry with backoff
Unexpected Returning.AI service error.
{
  "status": "fail",
  "message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}

Next step#