1. Bulk Operations
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
      GET
    • Get bulk update job status
      GET
    • Get bulk update job details
      GET
    • Bulk update users from CSV
      POST
    • Bulk update premium currency from CSV
      POST
  • Channels
    • Iframe
    • List integration channels
  • 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
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • 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
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Bulk Operations

Get bulk update job details

GET
/v1/users/bulk-update/{id}/details

What this endpoint does#

Returns row-level results for one bulk-update job ObjectId after you have the job from the list endpoint.
It does not queue a job. It does not list jobs. A missing well-formed id can return 200 with zero counts, not 404. Use status as the gate before treating details as processed output.
INFO
Workflow
List jobs → copy _id → poll status until Completed → GET /v1/users/bulk-update/{id}/details.

Quick start#

Replace <jobId> with a 24-character job ObjectId.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. Required permission: getBulkUpdate. Keep the key server-side.

Complete examples#

Completed job (200). message is Bulk update details fetched successfully. Envelope { status: "success", message, data: { successUsers, failedUsers, pagination, data } }.
Row objects include status, email, and the columns that job wrote.
Missing ObjectId (200). A well-formed id with no job can return successUsers: 0, failedUsers: 0, empty pagination. That is not the same contract as status (500 Bulk update not found).
Invalid id (400). Bulk update ID is required and must be a valid ObjectId.
Treat emails as synthetic.

Success and readback#

HTTP 200. Use status=Completed on the sibling status route before treating data[] as processed output.
CHECK
Missing job vs empty result
Status 500 Bulk update not found means the id did not match. Details 200 with zeros can mean the same missing id, or a job with no processed rows. Confirm _id on the list.

Errors and recovery#

StatusWhenRecovery
400 invalid ObjectIdMalformed {id}Send a 24-character hex id from the list.
401Missing or invalid tokenAdd a valid community key.

Retry safety#

TIP
Exact retry
This GET does not mutate users. Retry timeouts with bounded backoff. Repeating details does not re-run the job.

Gotchas#

Status and details are different missing-job contracts.
Details can parse the original payload before processing finishes. Wait for Completed.
List status casing can differ from the status endpoint. Compare job _id.

Next steps#

Get bulk update job status
Poll until Completed before trusting these rows.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/users/bulk-update//details?page=undefined&limit=undefined'
Response Response Example
200 - Example 1
{}
Modified at 2026-08-19 13:43:30
Previous
Get bulk update job status
Next
Bulk update users from CSV
Built with