Returning.AI
  1. Users
Returning.AI
  • Returning.AI
    • Auth
      • secure auth
      • register
      • verify email
      • login
    • Server
      • create new server
      • get my servers
      • update server
      • role list of server
      • channel list of server
    • Role
      • create new role
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • Users
        • Create New User
          POST
        • Get User Data
          POST
        • Get Users with Filters
          POST
        • Manage User account
          POST
        • Get User Gamification History
          GET
        • Get User Gamification Stats
          POST
        • Bulk Import
          POST
        • Bulk Update
          POST
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Api Key
        • Get User Api Key
        • Post User Api Key
        • Update User Api Key
        • Delete Endpoint
        • api key info
    • Application
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • User Field Histories
        • Get all user field histories in a community
        • Get user field histories for a specific field
        • Get user field histories for a specific user
        • Get user field histories of specific user field and user
        • Create user field history for specific user
  1. Users

Bulk Import

POST
/apis/v1/users/bulk-import
This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file.
No Authorization is needed
Community ID is used to identify where to add the users to, ID can be found in settings > Appearance
image.png

CSV file#

The CSV file template can be found in the userlist page, the file must follow the given template for column names.
image.png
Leave the cell empty if update for that field is not required.

After sending the request#

After API is called, head to the API log in the community setting to track its progress.
image.png

Request

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://integration.returning.ai/apis/v1/users/bulk-import' \
--form 'data=@""' \
--form 'communityId=""'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-08-27 07:53:46
Previous
Get User Gamification Stats
Next
Bulk Update