Skip to main content

CreateDependentBenefitEnrollmentInput

Input for creating a new enrollment for a dependent in a benefit

input CreateDependentBenefitEnrollmentInput {
  benefitId: ID!
  dependentId: ID!
  eligibilityEndDate: DateTime
  eligibilityStartDate: DateTime
  externalReferenceId: String
}

Fields​

CreateDependentBenefitEnrollmentInput.benefitId ● ID! non-null scalar​

Public ULID of the offering

CreateDependentBenefitEnrollmentInput.dependentId ● ID! non-null scalar​

First Dollar User ID of the dependent

CreateDependentBenefitEnrollmentInput.eligibilityEndDate ● DateTime scalar​

End datetime of eligibility. Optional. When omitted, defaults to the end of the account holder's enrollment in the Benefit, or no end date if that enrollment has none. Cannot be later than the end of the account holder's enrollment.

CreateDependentBenefitEnrollmentInput.eligibilityStartDate ● DateTime scalar​

Start datetime of eligibility. Optional. When omitted, the enrollment is stored without a start date: eligibilityStartDate is null. It does not default to the current datetime.

CreateDependentBenefitEnrollmentInput.externalReferenceId ● String scalar​

Idempotency key. A request sent again with the same key returns the first successful result. Keys do not expire. The request body is not compared, so use a new key for a different request. The value is also stored as the enrollment's externalReferenceId.

Member Of​

createDependentBenefitEnrollment mutation