Upload Users API
Bulk import users into the system through batch upload processing
Upload Users API
Import multiple users into the system at once. Trigger batch processing of user data for efficient bulk user creation.
Bulk Import
Add many users at once.
Batch Processing
Efficient mass creation.
Scale Easily
Handle large user imports.
Endpoint Overview
/graphqlTrigger the batch upload process for importing multiple users into the system. This processes a previously staged user data file.
GraphQL Mutation
mutation uploadUsers {
uploadUsers {
success
processedCount
message
}
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-d '{
"query": "mutation uploadUsers { uploadUsers { success processedCount message } }"
}'Response
{
"data": {
"uploadUsers": {
"success": true,
"processedCount": 150,
"message": "150 users imported successfully"
}
}
}{
"data": {
"uploadUsers": {
"success": true,
"processedCount": 145,
"message": "145 of 150 users imported. 5 failed due to duplicate emails."
}
}
}{
"errors": [
{
"message": "No user data staged for upload",
"path": ["uploadUsers"],
"extensions": {
"code": "NO_DATA"
}
}
],
"data": null
}Import Workflow
Prepare Data
Stage Upload
Process
Verify
Use Cases
Initial Setup
Populate system with existing users.
Migration
Move users from another system.
Enterprise
Bulk provision corporate accounts.
Events
Create accounts for events/trials.
Data Format Requirements
Valid email for each user.
Password
Initial password or auto-generate.
Group ID
Subscription group assignment.
Profile Data
Optional name and contact info.
Best Practices
Validate First
Check data format before upload.
Test Small
Test with small batch first.
Unique Emails
Ensure no duplicate emails.
Monitor Progress
Track import status.
Related Endpoints
File Staging Required
This endpoint processes staged user data. Ensure user data has been properly uploaded to the staging area before calling this mutation.
Need to Add Single Users?
For individual user creation, use the Create User endpoint instead.