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
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a 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 Custom User Field
          • Delete Custom 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 Stats
            POST
          • Bulk Import
            POST
          • Bulk Update
            POST
          • Premium Currency Bulk Update
            POST
          • Get All Bulk Update
            GET
          • Check Bulk Update Status
            GET
          • Check Bulk Update Details
            GET
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
        • Gamifications
          • Get User Gamification History
          • Get User Gamification Logs
        • Analysis API
          • Create Analysis
          • Get Analysis
          • Update Analysis
          • Delete Analysis
          • List Analyses
          • Append Drawings
        • Redemption Transactions
          • Update redemption transaction status
        • Streak Logs
          • Get Streak Logs
    • 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
  • Schemas
    • Analysis
      • UpdateAnalysisRequest
      • AppendDrawingsRequest
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ValidationError
      • NotFoundError
      • InternalServerError
      • NotImplementedError
      • CreateUserFieldHistoryResponse
      • CreateUserFieldHistorySuccessResponse
      • UserFieldHistoryItem
      • GetUserFieldHistoriesResponse
      • UserFieldHistoriesValidationError
      • UserFieldHistoriesMetaWithValidation
      • UserFieldHistoriesMetaWithPagination
      • GetUserFieldHistoriesSuccessResponse
      • CreateUserFieldResponse
      • CreateUserFieldSuccessResponse
      • DeleteUserFieldResponse
      • DeleteUserFieldSuccessResponse
      • UserFieldCreator
      • GetUserFieldResponse
      • GetUserFieldSuccessResponse
      • ValidationErrorItem
      • GetUserFieldsMetaResponse
      • CreatorInfo
      • UserFieldResponse
      • GetUserFieldsSuccessResponse
      • UpdateUserFieldResponse
      • UpdateUserFieldPayload
      • UpdateUserFieldSuccessResponse
      • MetaResponse
      • GetUserResponse
      • GetUserSuccessResponse
    • Outgoing webhooks
      • Purchased store item
      • New message posted to channel
      • User visits server
      • User join server
      • ErrorResponse
  1. Users

Premium Currency Bulk Update

POST
/apis/v1/users/bulk-update-premium-currency
This endpoint allows updating multiple users' premium currency 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 Format#

Email,Premium Currency,Premium Currency_op
test@gmail.com,100,add
Currency_op --> add, overwrite, subtract

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-premium-currency' \
--header 'Authorization: Bearer <token>' \
--form 'data=@"/Users/heinwaiyanhtet/Downloads/boolean - Sheet1 (2).csv"' \
--form 'log_name=""'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "message": "Bulk update premium currency process is queued",
    "data": {
        "message": "Bulk update premium currency process is queued. You can check in Api Log ( community settings )"
    }
}
Modified at 2026-02-25 01:54:59
Previous
Bulk Update
Next
Get All Bulk Update