TOtotalpass
Eligibles

Enqueue a bulk creation of eligible employees

Changed on

This only enqueues the operation — a successful response does not mean the items were processed. Check the real outcome with GET /api/v1/operations/{id}.

Creates multiple eligible employees in the company group asynchronously. Each item associates an employee to a specific company with optional additional info. Maximum of 200 items per request.

post/api/v1/eligibles/bulk_create

Request

  • Base URL
    https://company-eligibles-api.totalpass.com
  • URL
    https://company-eligibles-api.totalpass.com/api/v1/eligibles/bulk_create
  • Auth
    HTTP bearer

Request body

sourcestring

Optional identifier for the request origin (e.g. system name)

Example request

{
  "source": "hr-system",
  "data": [
    {
      "eligible_identifier": "12345678901",
      "company_identifier": "12345678000195",
      "additional_info": {
        "full_name": "John Doe",
        "email": "john@example.com",
        "phone_number": "11999999999",
        "optional_identifier": "12131"
      }
    }
  ]
}

Response

Operation enqueued successfully — this does not indicate the items were processed; poll GET /api/v1/operations/{id} for the result.

idinteger required

Operation ID used to track progress

created_atstring date-time required
status'pending' | 'processing' | 'finished' | 'finished_with_errors' | 'invalidated' required

Current status of the operation. A successful response here only means the request was accepted — poll GET /api/v1/operations/{id} to confirm when it actually finishes and see per-item results.

Example response

{
  "id": 42,
  "created_at": "2026-05-21T10:00:00.000Z",
  "status": "pending"
}

Changes