Path Parameters
string
required
Unique interview identifier (e.g.,
int_abc123def456)Request Body
string
ISO 8601 timestamp to reschedule the interview
string
Updated job position or role title
array
Updated array of skills to assess
integer
Updated interview duration in minutes (15-90)
string
Updated difficulty level:
junior, intermediate, senior, expertstring
Updated company name for personalization
string
Updated custom instructions for the AI interviewer
string
Updated candidate email (scheduled interviews only)
boolean
default:"true"
Whether to notify candidate of changes via email
string
Reason for rescheduling (included in notification email)
Update Rules by Status
Different fields can be updated based on interview status:Response
string
Unique interview identifier
string
Current interview status
string
Updated candidate email
string
Updated job position
array
Updated skills array
string
Updated schedule timestamp
integer
Updated duration
string
Updated difficulty level
string
Updated company name
string
Updated custom instructions
string
ISO 8601 timestamp when interview was last updated
boolean
Whether update notification was sent to candidate
Examples
Error Responses
Webhook Events
Updating an interview triggers webhook events based on the changes:interview.updated- Sent for any interview updateinterview.rescheduled- Sent when scheduled_at is changedcandidate.notified- Sent when notification email is delivered
Best Practices
Rescheduling Guidelines
- Professional Communication
- Batch Operations
- Validation
Skill Assessment Updates
When updating skills or difficulty:- Preserve Context: Keep related skills together for coherent assessment
- Match Difficulty: Ensure difficulty level matches the skills being tested
- Update Instructions: Modify custom instructions to reflect new focus areas
Candidates receive email notifications for significant changes (rescheduling, skill updates) unless
send_notification: false is specified.