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 

1{
2  "batchJobName": "GroupBenefitsEnrollment_Q1",
3  "flowName": "MyEnrollmentFlow"
4}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
batchJobNameStringName 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.Optional65.0
flowNameStringAPI 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.Optional68.0