Docs
API reference

Resend an invitation

POST
/api/v1/interviews/{id}/resend

Queue another email for the same pending interview when the candidate needs the invitation again. This does not create a new interview or charge for one.

Before you call

Use a current, eligible pending interview ID and a new Idempotency-Key for each intentional resend. No JSON body is needed.

Required scope: interviews:write.

What happens next

Save deliveryId and inspect emailDelivery on the interview. The candidate credential is unchanged. A 202 means the email was queued, not delivered to an inbox.

Recovery

Retry a timed-out resend with the same key. A conflict means the invitation is no longer eligible. Providers may duplicate an email if an acknowledgment is lost; avoid repeated fresh resend keys.

Follow the complete workflow · Errors and retries

Authorization

ApiKey
headerAuthorizationBearer <token>

Path Parameters

id*string

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

Length1 <= length <= 100

Header Parameters

Idempotency-Key*string

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.

Match^[A-Za-z0-9._:-]+$
Length1 <= length <= 128

Response Body

Save deliveryId and inspect emailDelivery on the interview. The candidate credential is unchanged. A 202 means the email was queued, not delivered to an inbox.

application/json
  1. response
data*
# Set PROBB_URL and PROBB_API_KEY. Replace RESOURCE_ID if present.# Set REQUEST_KEY once for this logical write; reuse it with the same body on retries.curl --fail-with-body -X POST "$PROBB_URL/api/v1/interviews/RESOURCE_ID/resend" \  -H "Authorization: Bearer $PROBB_API_KEY" \  -H "Idempotency-Key: $REQUEST_KEY"
{  "data": {    "interviewId": "interview_example",    "deliveryId": "delivery_example"  }}