Import users in bulk

POST /users/bulk-import
Copied
Arrow
                https://api.ocamba.com/v1/hood/users/bulk-import

Import multiple users if valid data is provided

Request Body Schema
Arrow
Name
Description
fileobjectrequired
Valid csv file containing user data


Example: --form 'text/csv=@"users.csv"'
mapobject
Map of key value pairs used for mapping the header from csv file to field names of users on Ocamba. The key represents header value, the value represents field name from Ocamba.


Example: --form 'application/json=@"{"tag":"tag_id","phone":"mobile_phone_number"}"'
Response status codes
Arrow
200 - OK
Arrow
note
1 The file must be a valid csv file.
2 Csv must contain values for tag_id and at least one of email, mobile_phone_number or push_credentials.
Request examples
Copied
Arrow
200 Arrow
  • 200
--form 'file=@"users.csv"'
--form 'map=@"{"tag":"tag_id","phone":"mobile_phone_number"}"'
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "message": "Inserted 2 out of 2 users."
}