POST api/email/screening-incomplete

Queues the "student-forms-incomplete" email for a student whose form was moved to Incomplete by AI screening.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
StudentProgramId	StudentProgram id used to resolve the student recipient and build the form URL.	integer	Required
SurveyId	UTZ survey ObjectId string, used to build the form URL.	string	None.
FormName	Name of the form that was moved to Incomplete.	string	None.
Reasoning	Reasoning text (Storyblok email contents) shown to the student.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "studentProgramId": 1,
  "surveyId": "sample string 2",
  "formName": "sample string 3",
  "reasoning": "sample string 4"
}

application/xml, text/xml

Sample:

<ScreeningIncompleteEmailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Email">
  <FormName>sample string 3</FormName>
  <Reasoning>sample string 4</Reasoning>
  <StudentProgramId>1</StudentProgramId>
  <SurveyId>sample string 2</SurveyId>
</ScreeningIncompleteEmailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.