Returning.AI
  1. Users
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • role list of server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • 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
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get specific user field
          • Create Custom 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
      • Integration API
        • Users
          • Get Users with Filters
            POST
          • Create New User
            POST
          • Get User Data
            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
        • API key
          • api key info
          • Get User Api Key
          • Post User Api Key
          • Update User Api Key
          • Delete Endpoint
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • 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
      • Channels
      • Leaderboard
      • Milestone
      • Socials
      • Store
  1. Users

Bulk Update

POST
/apis/v1/users/bulk-update
This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file.

Authorization#

Bearer token Required
Found in the platform under community settings > API keys.
Permission: Bulk Update User

CSV file#

The CSV file template can be found in the userlist page, the file must follow the given template for field names.
image.png
Include all the columns that update is required, columns that do not need update can be removed.

For numerical fields#

Numerical fields have a operator which allow users to add , subtract or overwrite the value. (case sensitive, do not capitalise)
This is added in the column before the field value, with the heading: field name_op.
Example:
image.png
Note: Non-numerical fields will be overwriten.

After sending the request#

After the file is uploaded and send, head to the API log in the community setting to track its progress.
image.png

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
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-update' \
--header 'Authorization: Bearer <token>' \
--form 'data=@""'

Responses

🟢200Success
application/json
Body

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 2025-08-27 07:36:48
Previous
Bulk Import
Next
Send Message