Sending Predictive Indicator Surveys

Sending Predictive Indicator surveys is simple. The employee that should receive the survey needs a start date and to be opted into receiving surveys. Once these two fields are populated surveys will be automatically scheduled to send to the employee. This can be done a few ways.

Opt an employee in via Admin UI

1. Navigate to the employee list
2. Create or edit the new employee
3. Enter the employee's start date
4. Select Opt into Surveys

Opt an employee in via API

Using the Candidates - POST (new records) or Candidates/{id} - PATCH (updates) pass the employee's start date in  startDate and true for optIntoSurveys in the  userInfo object

E.g. 

{
    "startDate": "2026-03-25",
    "userInfo": {
        "optIntoSurveys": true
    }
}

Opt an Employee in via SFTP Import

Begin sending StartDate and OptIntoSurveys on the csv file.

Send surveys ad-hoc

If a survey needs to be sent before the scheduled date you can do so by:

1. Navigating to the Employee List
2. Selecting the employee
3. Selecting Surveys
4. Selecting Send (mail icon) next to the survey

Canceling Surveys

Surveys can be canceled one of two ways:

Termed Employees

When an employee has a termination date added, they will automatically be opted out of surveys.

Active Employees

To stop sending surveys to an employee who is still active, simply flip the Opt Into First Year Surveys flag to false using any of the methods noted in the Opt In section above.