Update State

put
/employers/{employerId}/employees/{employeeId}/autoenrolment/state

Updates the AutoEnrolment state for an Employee.
You would use this API call to process notices such as Opt Out, Opt In, etc.
A new assessment is returned showing the result of the state change.

Store values

Parameters

string
The Id of the Employer to which the Employee belongs
string
The Id of the Employee you want to set the status for
string
The AutoEnrolment State to set for the Employee (optional)
string
(optional)
string
Optional. Will default to the current date (optional)
string
Optional. Used to override the default AE Pension. Only valid with states of Enrol, VoluntaryJoiner or OptIn (optional)
string
Optional. Used to override the default AE Pension Workergroup. Only valid with states of Enrol, Join or OptIn. Must be provided if a pensionId is being provided. (optional)
Try it

Possible Responses

201 Success AeAssessment
200 Success AeAssessment
404 Not Found