> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interviewflowai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit Interview API

> Update an existing Candidate interview from an external system.

Use the Edit Interview API to update an interview that belongs to your Company.

## Endpoint

```text theme={null}
PUT https://api.interviewflowai.com/api/external/interview
```

## Request body fields

| Field                       | Type   | Required | Description                                                      |
| --------------------------- | ------ | -------- | ---------------------------------------------------------------- |
| `interviewId`               | string | ✅ Yes    | The UUID of the interview to update.                             |
| `candidateName`             | string | ❌ No     | The Candidate's name.                                            |
| `viewStatus`                | string | ❌ No     | `new` or `viewed`.                                               |
| `status`                    | string | ❌ No     | A stage configured in your Company's **Custom Stages** settings. |
| `customQuestions`           | array  | ❌ No     | Replacement custom interview questions.                          |
| `candidateAdditionalFields` | object | ❌ No     | Replacement values for configured Candidate additional fields.   |
| `recruiterNotes`            | string | ❌ No     | Internal notes, up to 5,000 characters.                          |

At least one optional field should be included. Sending a `status` that is not configured as a custom stage returns `400 Bad Request`.

## Example

```bash theme={null}
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

```json theme={null}
{
  "code": 200,
  "message": "Interview updated successfully"
}
```

The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns `404 Not Found`.