Workday Benefits · Schema
Benefit Enrollment Request
Request to create or update a benefit enrollment
Properties
| Name | Type | Description |
|---|---|---|
| employeeId | string | Employee identifier |
| planId | string | Benefit plan identifier |
| coverageLevel | string | Desired coverage level |
| effectiveDate | string | Enrollment effective date |
| dependentIds | array | List of dependent IDs to enroll |
| waiveReason | string | Reason for waiving coverage |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/workday-benefits/refs/heads/main/json-schema/workday-benefits-benefit-enrollment-request-schema.json",
"title": "Benefit Enrollment Request",
"description": "Request to create or update a benefit enrollment",
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"description": "Employee identifier"
},
"planId": {
"type": "string",
"description": "Benefit plan identifier"
},
"coverageLevel": {
"type": "string",
"enum": [
"EMPLOYEE_ONLY",
"EMPLOYEE_PLUS_SPOUSE",
"EMPLOYEE_PLUS_CHILDREN",
"EMPLOYEE_PLUS_FAMILY"
],
"description": "Desired coverage level"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "Enrollment effective date"
},
"dependentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of dependent IDs to enroll"
},
"waiveReason": {
"type": "string",
"description": "Reason for waiving coverage"
}
},
"required": [
"employeeId",
"planId",
"coverageLevel",
"effectiveDate"
]
}