Bulk Import Employees
Import up to 500 employee records in a single request.
POST
/api/v1/employees/bulk-importDescription
Creates employee location records from an array. Validates all rows before inserting; if any row fails validation, no records are processed. Skips emails that already exist for the company.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| employees | array | Yes | Array of employee objects (max 500). Supports camelCase or PascalCase field aliases. |
Each object in employees[]
Same fields as Create Employee. Aliases accepted: FirstName, LastName, LocationName, etc.
Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| firstname | string | Yes | First name (letters and spaces only). |
| lastname | string | Yes | Last name (letters and spaces only). |
| location_name | string | Yes | Location display name. |
| location_type | string | Yes | Warehouse, Corporate Office, Retail Store, or Remote Employee. |
| contact_info | string | Yes | Phone number (digits only). |
| contact_country | string | No | Phone country code (e.g. US). |
| string | Yes | Unique employee email. | |
| address_1 | string | Yes | Street address line 1. |
| address_2 | string | No | Street address line 2. |
| city | string | Yes | City. |
| state | string | No | State/province (required except UK). |
| zip | string | Yes | Postal code. |
| country | string | Yes | Country code or name (e.g. US). |
Example Request Body
{
"employees": [
{
"firstname": "John",
"lastname": "Doe",
"location_name": "San Francisco Remote Hub",
"location_type": "Remote Employee",
"contact_country": "US",
"contact_info": "4155550198",
"email": "john.doe@example.com",
"address_1": "123 Market Street",
"address_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US"
},
{
"firstname": "Jane",
"lastname": "Smith",
"location_name": "San Francisco Remote Hub",
"location_type": "Remote Employee",
"contact_country": "US",
"contact_info": "4155550198",
"email": "jane.smith@example.com",
"address_1": "123 Market Street",
"address_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US"
}
]
}Response
Related Endpoints
Did this page help you?
Request
curl -X POST https://uat.unduit.com/api-exposed/api/v1/employees/bulk-import \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"employees": [
{
"firstname": "John",
"lastname": "Doe",
"location_name": "San Francisco Remote Hub",
"location_type": "Remote Employee",
"contact_country": "US",
"contact_info": "4155550198",
"email": "john.doe@example.com",
"address_1": "123 Market Street",
"address_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US"
},
{
"firstname": "Jane",
"lastname": "Smith",
"location_name": "San Francisco Remote Hub",
"location_type": "Remote Employee",
"contact_country": "US",
"contact_info": "4155550198",
"email": "jane.smith@example.com",
"address_1": "123 Market Street",
"address_2": "Suite 400",
"city": "San Francisco",
"state": "CA",
"zip": "94103",
"country": "US"
}
]
}'Success Response
{
"message": "Address added successfully",
"address": [
{
"id": 501,
"firstname": "encrypted...",
"lastname": "encrypted...",
"email": "encrypted...",
"location_name": "encrypted...",
"company_id": 317,
"location_type": "Remote Employee",
"created_at": "2026-06-03 12:00:00"
}
]
}Error Responses
422 Validation Error
{
"errors": {
"row_errors": [
{ "index": 0, "errors": ["Row 1: email must be valid"] }
]
}
}