curl --request POST \
--url https://staging.api.us.aptlydone.com/auth/v1/user/bulk-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tenantId": "42db2b59-b9c6-4705-a0d9-916e597cd4aa",
"users": [
{
"firstName": "Maryam",
"lastName": "Smith",
"email": "[email protected]",
"mobilePhone": "+1 (555) 123-4567",
"roleIds": [
"bbc5418c-8d81-4756-b3e6-84e1e87f06c3"
],
"groups": [
{
"groupId": "e9100cc7-048a-4d01-a64f-9e0030938f6a",
"isPrimaryOrg": true
}
],
"managerId": "623010c7-bbd4-4cab-94ca-a3b617a74933",
"positionIds": [
"b545c2fe-681c-4cf6-a6f6-e0bcea69bad3"
],
"existingUser": {}
}
]
}'
{
"statusCode": 200,
"timestamp": "2025-06-25T06:16:48.664Z",
"message": "Success",
"data": {
"total": 10,
"successful": 8,
"failed": 2,
"results": [
{
"email": "[email protected]",
"success": true,
"message": "Invitation sent successfully"
},
{
"email": "[email protected]",
"success": false,
"message": "Email already exists"
}
]
}
}
curl --request POST \
--url https://staging.api.us.aptlydone.com/auth/v1/user/bulk-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tenantId": "42db2b59-b9c6-4705-a0d9-916e597cd4aa",
"users": [
{
"firstName": "Maryam",
"lastName": "Smith",
"email": "[email protected]",
"mobilePhone": "+1 (555) 123-4567",
"roleIds": [
"bbc5418c-8d81-4756-b3e6-84e1e87f06c3"
],
"groups": [
{
"groupId": "e9100cc7-048a-4d01-a64f-9e0030938f6a",
"isPrimaryOrg": true
}
],
"managerId": "623010c7-bbd4-4cab-94ca-a3b617a74933",
"positionIds": [
"b545c2fe-681c-4cf6-a6f6-e0bcea69bad3"
],
"existingUser": {}
}
]
}'
{
"statusCode": 200,
"timestamp": "2025-06-25T06:16:48.664Z",
"message": "Success",
"data": {
"total": 10,
"successful": 8,
"failed": 2,
"results": [
{
"email": "[email protected]",
"success": true,
"message": "Invitation sent successfully"
},
{
"email": "[email protected]",
"success": false,
"message": "Email already exists"
}
]
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Users invited successfully
The response is of type object
.