Delete Interviews | Gradii API Documentation

curl -X DELETE https://gradii.ai/api/v2/interviews/delete \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "interviewId": "interview_987xyz_candidateId_654321",
  "reason": "Candidate accepted another offer",
  "notifyCandidate": true
}'

{
  "success": true,
  "data": {
    "interviewId": "interview_987xyz_candidateId_654321",
    "candidateName": "Alice Johnson",
    "candidateEmail": "alice.johnson@example.com",
    "campaignName": "Marketing Manager Recruitment",
    "jobTitle": "Marketing Manager",
    "status": "scheduled",
    "scheduledAt": "2024-05-10T14:00:00.000Z",
    "roundOrder": 2,
    "deletedAt": "2024-04-20T09:30:00.000Z",
    "reason": "Candidate accepted another offer",
    "deleted": true,
    "emailSent": true,
    "notifyCandidate": true
  },
  "message": "Interview deleted successfully",
  "timestamp": "2024-04-20T09:30:00Z",
  "version": "2.0"
}

Cancel/delete single or multiple interviews. Cannot delete completed or in-progress interviews.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Cannot delete completed interviews (kept for records) Cannot delete in-progress interviews Cancellation email sent automatically if notifyCandidate=true and status=scheduled Interview is permanently deleted from database

interviewIdstringRequired

Interview ID

reasonstringOptional

Cancellation reason (max 500 chars)

notifyCandidatebooleanOptional

Send cancellation email (default: true)

Response

Interview deleted successfully (single)

successbooleanOptional

dataobjectOptional

messagestringOptional

timestampstringOptional

versionstringOptional

Errors

400

Bad Request Error