Workday Benefits · JSON Structure

Workday Benefits Benefit Enrollment Request Structure

Request to create or update a benefit enrollment

Type: object Properties: 6 Required: 4

Workday Benefits Benefit Enrollment Request Structure is a JSON Structure definition published by Workday Benefits, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

employeeId planId coverageLevel effectiveDate dependentIds waiveReason

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-benefits/refs/heads/main/json-structure/workday-benefits-benefit-enrollment-request-structure.json",
  "title": "Benefit Enrollment Request",
  "description": "Request to create or update a benefit enrollment",
  "type": "object",
  "properties": {
    "employeeId": {
      "description": "Employee identifier",
      "type": "string"
    },
    "planId": {
      "description": "Benefit plan identifier",
      "type": "string"
    },
    "coverageLevel": {
      "description": "Desired coverage level",
      "type": "string",
      "enum": [
        "EMPLOYEE_ONLY",
        "EMPLOYEE_PLUS_SPOUSE",
        "EMPLOYEE_PLUS_CHILDREN",
        "EMPLOYEE_PLUS_FAMILY"
      ]
    },
    "effectiveDate": {
      "description": "Enrollment effective date",
      "type": "date"
    },
    "dependentIds": {
      "description": "List of dependent IDs to enroll",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "waiveReason": {
      "description": "Reason for waiving coverage",
      "type": "string"
    }
  },
  "required": [
    "employeeId",
    "planId",
    "coverageLevel",
    "effectiveDate"
  ]
}