Get a fresh interview link
POST/interviews/:interview_id/relink
Issues a new interview_url, in case you lost the one from Create an interview or
the candidate never opened it before your own copy was wiped.
The old link stops working. Never call this while the candidate is interviewing: reissuing a link mid-session
would end it, so this refuses with 409 interview_live instead. It also refuses with
409 job_not_interview_ready in the same rare case Create an interview would (the job's workflow changed
underneath an in-flight interview).
The role this key acts as needs the candidates:create permission.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 429
A fresh link.
The key is missing, malformed, expired or revoked.
The key is valid but may not do this: the role it acts as lacks the permission this call needs (forbidden,
with the permission in required), or the workspace's plan has lapsed (billing_past_due: reads still work,
adding candidates is paused) or is suspended (account_suspended).
There is no interview with that ID in your workspace.
The candidate is interviewing right now (interview_live), or the job's workflow no longer opens with an AI interview round (job_not_interview_ready).
Too many requests. Wait for Retry-After seconds, then retry.
Response Headers
Seconds to wait before retrying.