API Reference

Stop Interview

post
https://recruiter.classet.org/v1/candidates//stop-interview

Stops an in-progress interview workflow for a candidate. You can either send messages to the candidate or simply stop the outreach workflow without sending any messages. Requires that an interview was previously initiated and that no interview outcome has already been determined. The candidate's interview_outcome will be set to ai_stopped_override.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the candidate.

Body Params

Either only_stop_outreach must be true, or at least one message (SMS or email) must be provided.

string

SMS message to send to the candidate when stopping the interview. If provided, an attempt to send SMS will be made only if SMS is active for the candidate.

string

Email message to send to the candidate when stopping the interview. If provided, an attempt to send email will be made only if the candidate has instant_interview_email_message_id configured.

boolean

If true, only stops the outreach reminder nudges without sending any messages to the candidate. When this is true, any provided SMS or email messages will be ignored.

Responses

Updated 27 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago