Starred measures candidate experience after the application process has ended. Surveys are typically triggered when a candidate’s application status changes to one of the following:

• Rejected
• Withdrawn
• Hired

When building your integration, trigger the Starred API when one of these status changes occurs in your ATS.

Recommended trigger timing

The Starred API does not support built-in delays. Instead, configure your workflow to trigger the API 2–3 days after the status change.

This helps ensure:

• Accidental status changes do not trigger surveys immediately
• Candidates first receive the hiring decision from your team
• Candidates have time to process the outcome before being asked for feedback

Required API fields

All required fields in the API are listed in our API documentation.

Below, you find an overview of where to find these fields:

API Token

Used to authenticate requests via the Authorization header. Generate tokens in Company Settings → API Tokens

FormID

Identifies the survey that should be triggered.

TemplateID

Identifies the invitation email template to send. You can find this in the Sending Invitations section of the API page.

Sender

The email address used to send the invitation. This address must be an active Starred user and can be added in the Colleagues section.

💡 Tip: Use a generic sender address rather than linking the sender to a recruiter field. This simplifies access management and keeps feedback requests neutral.

Adding custom fields

You can include additional fields in the API call to enrich your survey responses and personalize invitations.

Add them using this format: &CustomField=Value

Example: &RecruiterName=JohnDoe

These fields can be used to:

• Segment feedback in dashboards
• Personalize invitation emails

To reference a custom field in an email template, add @ before the field name.

Example: “Thank you for applying for the @JobTitle position.”

Best practices:

• Avoid spaces in field names (e.g., use JobTitle instead of Job Title)
• Keep field names consistent across integrations and surveys
• Recommended custom fields

Common fields that help with analysis and personalization include:

Application context

JobTitle

RecruiterName

HiringManagerName

Segmentation

Country

Department

BusinessUnit

Office

Process insights

RejectionReason - Often used to distinguish between candidate withdrawal and company rejection.

Reminders

You can enable reminders by adjusting the API parameters. When enabled, Starred automatically sends a reminder 6 calendar days after the initial invitation to respondents who have not yet completed the survey.

💡 Note: Reminders cannot be added to invitations that were previously sent without reminders enabled.

In our API documentation you can learn how to modify your API parameters to enable reminders.

Cooling down period

Starred uses the recipient’s email address as a unique identifier and includes a built-in cooling down period. When enabled, this feature prevents the same email address from receiving multiple survey invitations within a defined timeframe.

This helps avoid survey fatigue and ensures a better experience for your candidates.

Read more about this feature in this support article.