Update Interviews | Gradii API Documentation

curl -X PUT https://gradii.ai/api/v2/interviews/update \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "interviewId": "interview_abc123_candidateId_1234567890",
  "interviewDate": "2024-02-20",
  "interviewTime": "15:00",
  "notes": "Rescheduled as requested by candidate"
}'

{
  "success": true,
  "data": {
    "id": "db-id-123",
    "campaignId": "123e4567-e89b-12d3-a456-426614174000",
    "candidateId": "cand_789",
    "setupId": "setup_456",
    "interviewId": "interview_abc123_candidateId_1234567890",
    "interviewType": "behavioral",
    "status": "scheduled",
    "roundOrder": 1,
    "scheduledAt": "2024-02-20T09:30:00.000Z",
    "timezone": "Asia/Kolkata",
    "linkExpiryTime": "2024-02-21T09:30:00.000Z",
    "interviewLink": "https://gradii.ai/interview/verify?email=john@example.com&interviewId=interview_abc123&type=behavioral",
    "candidateNotes": "Rescheduled as requested by candidate",
    "updatedAt": "2024-01-28T10:00:00.000Z",
    "campaignName": "Senior Developer Hiring",
    "jobTitle": "Senior Software Engineer",
    "candidateName": "John Doe",
    "candidateEmail": "john@example.com",
    "candidatePhone": "+11234567890",
    "emailSent": true,
    "updated": true
  },
  "message": "Interview updated successfully",
  "timestamp": "2024-01-28T10:00:00Z",
  "version": "2.0"
}

Update single or multiple interviews with automatic email notifications. Can update candidate info, scheduling, status, and notes.

Authentication

AuthorizationBearer

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

Request

If providing interviewDate or interviewTime, both must be provided together Scheduled time must be in the future Email notification sent automatically if scheduling is updated Cannot update completed or in-progress interviews to certain statuses

interviewIdstringRequired

Interview ID

candidateNamestringOptional

Updated candidate name (1-100 chars)

candidateEmailstringOptionalformat: "email"

Updated email (lowercase)

candidatePhonedoubleOptional

Updated phone (max 30 chars)

candidateCountryCodestringOptional

Country code

interviewDatestringOptional

New date YYYY-MM-DD (requires interviewTime)

interviewTimestringOptional

New time HH:MM or HH:MM:SS (requires interviewDate)

scheduledAtdatetimeOptional

Alternative to date/time - ISO datetime string

roundNumberintegerOptional

Round number (1-10), must exist in campaign

statusstringOptional

timezonestringOptional

Timezone

notesstringOptional

Updated notes (max 500 chars)

Response

Interview updated successfully (single)

successbooleanOptional

dataobjectOptional

messagestringOptional

timestampstringOptional

versionstringOptional