Edit Interview API
curl --request PUT \
--url https://api.interviewflowai.com/api/external/interview \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"interviewId": "<string>",
"candidateName": "<string>",
"viewStatus": "<string>",
"status": "<string>",
"customQuestions": [
{}
],
"candidateAdditionalFields": {},
"recruiterNotes": "<string>"
}
'import requests
url = "https://api.interviewflowai.com/api/external/interview"
payload = {
"interviewId": "<string>",
"candidateName": "<string>",
"viewStatus": "<string>",
"status": "<string>",
"customQuestions": [{}],
"candidateAdditionalFields": {},
"recruiterNotes": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
interviewId: '<string>',
candidateName: '<string>',
viewStatus: '<string>',
status: '<string>',
customQuestions: [{}],
candidateAdditionalFields: {},
recruiterNotes: '<string>'
})
};
fetch('https://api.interviewflowai.com/api/external/interview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.interviewflowai.com/api/external/interview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'interviewId' => '<string>',
'candidateName' => '<string>',
'viewStatus' => '<string>',
'status' => '<string>',
'customQuestions' => [
[
]
],
'candidateAdditionalFields' => [
],
'recruiterNotes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.interviewflowai.com/api/external/interview"
payload := strings.NewReader("{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.interviewflowai.com/api/external/interview")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.interviewflowai.com/api/external/interview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAPI Integration
Edit Interview API
Update an existing Candidate interview from an external system.
PUT
/
api
/
external
/
interview
Edit Interview API
curl --request PUT \
--url https://api.interviewflowai.com/api/external/interview \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"interviewId": "<string>",
"candidateName": "<string>",
"viewStatus": "<string>",
"status": "<string>",
"customQuestions": [
{}
],
"candidateAdditionalFields": {},
"recruiterNotes": "<string>"
}
'import requests
url = "https://api.interviewflowai.com/api/external/interview"
payload = {
"interviewId": "<string>",
"candidateName": "<string>",
"viewStatus": "<string>",
"status": "<string>",
"customQuestions": [{}],
"candidateAdditionalFields": {},
"recruiterNotes": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
interviewId: '<string>',
candidateName: '<string>',
viewStatus: '<string>',
status: '<string>',
customQuestions: [{}],
candidateAdditionalFields: {},
recruiterNotes: '<string>'
})
};
fetch('https://api.interviewflowai.com/api/external/interview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.interviewflowai.com/api/external/interview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'interviewId' => '<string>',
'candidateName' => '<string>',
'viewStatus' => '<string>',
'status' => '<string>',
'customQuestions' => [
[
]
],
'candidateAdditionalFields' => [
],
'recruiterNotes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.interviewflowai.com/api/external/interview"
payload := strings.NewReader("{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.interviewflowai.com/api/external/interview")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.interviewflowai.com/api/external/interview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"interviewId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"viewStatus\": \"<string>\",\n \"status\": \"<string>\",\n \"customQuestions\": [\n {}\n ],\n \"candidateAdditionalFields\": {},\n \"recruiterNotes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyUse the Edit Interview API to update an interview that belongs to your Company.
At least one optional field should be included. Sending a
The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns
Rate limit: 60 requests per minute per API key. Requests over the limit return
429 Too Many Requests.Endpoint
PUT https://api.interviewflowai.com/api/external/interview
Request body fields
string
required
The UUID of the interview to update.
string
The Candidate’s name.
string
new or viewed.string
A stage configured in your Company’s Custom Stages settings.
object[]
Replacement custom interview questions.
object
Replacement values for configured Candidate additional fields.
string
Internal notes, up to 5,000 characters.
status that is not configured as a custom stage returns 400 Bad Request.
Example
curl -X PUT "https://api.interviewflowai.com/api/external/interview" \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key_here" \
-d '{
"interviewId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"candidateName": "Taylor Morgan",
"status": "Technical Review",
"recruiterNotes": "Strong systems design experience."
}'
Success response
{
"code": 200,
"message": "Interview updated successfully"
}
404 Not Found.
