Group Enrollment Input

Input representation for the Group Enrollment API. Use these properties to label the asynchronous bulk enrollment job and, optionally, to specify a custom flow to run for each member of the census.

JSON Example

{
  "batchJobName": "GroupBenefitsEnrollment_Q1",
  "flowName": "MyEnrollmentFlow"
}

Properties

Name	Type	Description	Required or Optional	Available Version
`batchJobName`	String	Name that identifies the asynchronous batch job that enrolls the members of the group census. Use a descriptive value so that you can locate the job later when tracking its status.	Optional	65.0
`flowName`	String	API name of an optional custom flow to run for each member as part of the bulk enrollment, endorsement, or renewal process. If you don't specify a value, the default Enroll Member flow is used.	Optional	68.0