1. Bulk Operations
Returning.AI
  • Getting Started
  • Authentication
    • Secure Auth
      GET
    • register
      POST
    • verify email
      POST
    • login
      POST
  • Users
    • Get user
      GET
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Gamification Stats
      POST
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      POST
  • Roles & Permissions
    • role list of server
      GET
    • create new role
      POST
    • update role
      PUT
    • delete role
      DELETE
    • get role list of user on a server
      GET
    • add role to a user on a server
      POST
    • remove role from a user on a server
      POST
  • Servers
    • create new server
    • get my servers
    • update server
  • Channels
    • channel list of server
    • get channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • Messaging
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload Image
  • User Data
    • Get All User Fields
    • Get Specific User Field
    • Create Custom User Field
    • Update Custom User Field
    • Delete Custom User Field
    • 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
  • Gamification
    • get badges list
    • create new badge
    • update badge
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
      POST
    • Get All Bulk Update
      GET
    • Check Bulk Update Status
      GET
    • Check Bulk Update Details
      GET
    • Bulk Update
      POST
    • Premium Currency Bulk Update
      POST
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • Channels
    • Iframe
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • Features
  • Community Analytics
    • Get Loyalty Overview
  1. Bulk Operations

Bulk Import

POST
/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
Group 27011.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

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sgtr-api.returning.ai/v1/users/bulk-import' \
--form 'data=@""' \
--form 'communityId=""'
Response Response Example
    "status": "success",
    "message": "Bulk import user process is queued",
    "data": {
        "message": "Bulk import user process is queued. You can check in Api Log ( community settings )"
    }
}
Modified at 2026-04-07 08:50:16
Previous
Append Drawings
Next
Get All Bulk Update
Built with