Populate Upload

Adds employee events to a batch.

This endpoint allows you to populate a batch with employee events. Both employee creation/updates and deletions can be included in a single request using the appropriate event types.

Typical use-cases:

  • Bulk upload or update employee records in a batch.
  • Include deletions and updates in a single operation for efficient data management.

After successfully adding data, you can track the employee events you have added using the GET /v1/batches/{batch_id}/workforce endpoint.

us-east-2 eu-west-2 ap-southeast-2 ca-central-1 eu-central-1 ap-southeast-1

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier for the batch.

Body Params
employee_events
array
length ≤ 1000
Defaults to []
employee_events
Responses

400

Invalid request data

404

Batch not found

500

Internal server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json