> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bvndle.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Onboarding - Bulk
export const TableWIthLongDesc = ({data, name, type, desc}) =>
;
};
Onboard your users with this endpoint. Onboard as many user as possible with one call. This route is asynchronous. If request is successful, you’ll receive a webhook on your status.
Authenticate your API calls by including your secret key in the Authorization
header of every request you make. You can manage your API keys from the
dashboard.
####
##
Required {" "}
{`Array of object with each object containing userId and userData {“userId” : UUID, “userData: {object containing additional information about user}}`}
}
/>
```bash cURL theme={null}
curl --request POST 'https://test-api.bvndle.com/api/v1/laas/onboard-users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'\
--data-raw
‘
{ "users": [
{
"userId": "f0c8c81d-13d3-4515-b40f-711ef91de094",
"userData":
{
"name": "User1",
"otherInfo": "goes here",
"additionalInfo1": "goes here",
"additionalInfo2": "goes here",
"note": "you can add any key as much as you want to save on user"
}
},
{
"userId": "65433e42-a68f-48dc-89fa-1f523df7af87",
"userData":
{
"name": "User5",
"otherInfo": "goes here 5",
"additionalInfo1": "goes here 5",
"additionalInfo2": "goes here 5",
"note": "you can add any key as much as you want to save on user 5"
}
}
]
}’
```
```json Success theme={null}
{
"status": "success",
"message": "request received successfully"
}
```
```json Error 400 theme={null}
{
"status": "failed",
"message": "invalid data provided",
"data": {
"errorType": "invalid",
"appErrorCode": "Bad request",
"error": "\"users[0].userId\" must be a valid GUID"
}
}
```
```bash WEBHOOK FORMAT theme={null}
Success
{
"event": "USER_ONBOARDING",
"status": "success",
"failed": []
}
{"user":"4d7b55c0-716e-4db1-8c01-91f5922746b4","reason":"duplicate key value violates unique constraint \"UQ_e38c53eed7cc80d27d280388381\""} ] }
```