Interviews

Create a reinterview

Create a new interview attempt for a candidate who needs another session. Unlike resend, this prepares a new interview and uses the current assigned version and allowance.

Before you call

Use the previous interview ID, a fresh quote for the same report, invitation details, and a new Idempotency-Key. An in-progress session cannot be replaced.

Required scope: interviews:write.

What happens next

Save the newly returned interviewId. Previous public results remain tied to the old attempt. Old invitation links cannot enter the replacement session.

Recovery

Check the old lifecycle before replacing it. Retry identical requests after timeouts; requote with a new key if configuration has changed. Do not use reinterview merely to resend an email.

Follow the complete workflow · Errors and retries

post/api/v1/interviews/{id}/reinterview

Request

  • Base URL: https://app.probbai.com
  • URL: https://app.probbai.com/api/v1/interviews/{id}/reinterview
  • Auth: HTTP bearer

Path parameters

idstring required

Resource ID returned by this resource's creation or list endpoint. See prerequisites for whether this is a report, interview, job, or batch ID.

Headers

Idempotency-Keystring required

Stable key for one logical write. Retry the identical body with the same key after a timeout; a changed body conflicts. 1–128 letters, digits, dots, underscores, colons, or hyphens.

Request body

reportIdstring required

Report ID returned by upload preparation, admission, discovery, or an event. It must belong to the API key's workspace.

candidateEmailstring email required

Email address of the intended candidate. The quote and invitation must use the same address.

sendEmailboolean

True (default) asks ProBB AI to email the invitation. False returns a private link credential for your system to deliver. Invitation batches require true.

quoteFingerprintstring required

Fingerprint copied unchanged from the corresponding current quote. Changing quote inputs requires a new quote.

Response

Save the newly returned interviewId. Previous public results remain tied to the old attempt. Old invitation links cannot enter the replacement session.

Changes

No recorded changes to this operation across all 1 revision of this API.