WEwellhub
Jobs

Add items to a job

Adds a batch of employee records to an existing draft job. Each item represents a single employee operation (CREATE, UPDATE, or DELETE). A request must contain between 1 and 500 items. The company_tax_id and operation fields are required per item.

post/v1/eligibility/jobs/{job-id}/items

Request

Path parameters

job-idstring uuid required

The UUID of the draft job to add items to.

Request body

operation'CREATE' | 'UPDATE' | 'DELETE' required

The operation to perform for this employee record.

company_tax_idstring required

The tax ID of the company this employee belongs to.

emailstring

Employee's email address.

full_namestring

Employee's full name.

employee_idstring

Client-defined employee identifier.

national_idstring

Employee's national identifier.

payroll_idstring

Payroll identifier for the employee.

employee_segmentstring

Identifies the employee's segment for NR01. Alphanumeric, may include special characters, no length limit.

departmentstring

Department the employee belongs to.

office_zip_codestring

ZIP code of the employee's office location.

cost_centerstring

Cost center associated with the employee.

mobile_numberstring

Employee's mobile phone number.

discount_subset_idstring

Identifier for the discount subset applicable to this employee.

eligible_to_payrollboolean

Whether the employee is eligible for payroll deduction.

custom_fieldsobject

Optional map of additional custom attributes for the employee. Values are not validated by the platform.

Example request

[
  {
    "company_tax_id": "12.345.678/0001-99",
    "email": "jane.doe@example.com",
    "full_name": "Jane Doe",
    "employee_id": "EMP001",
    "national_id": "123.456.789-00",
    "payroll_id": "PAY-9876",
    "employee_segment": "SALES",
    "department": "Engineering",
    "office_zip_code": "01310-100",
    "cost_center": "CC-001",
    "mobile_number": "+5511999999999",
    "discount_subset_id": "SUBSET-A",
    "eligible_to_payroll": true
  }
]

Response

No Content. All items were successfully added to the job.

Changes

No recorded changes to this operation across all 1 revision of this API.