> ## 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.

# Update custom fields

> Sync scores and flags from your tools into a Candidate's additional fields.

The Patch API allows you to update custom fields for a specific interview record. This is highly useful for syncing data, scores, or review flags from your external tools back into InterviewFlowAI.

> [!NOTE]
>
> **Rate limit:** 60 requests per minute per API key. Requests over the limit return `429 Too Many Requests`.

## Request body fields

**interviewId** `string` *required*

The UUID of the interview to update.

**candidateAdditionalFields** `object` *required*

Custom fields to update on the Candidate record. Include 1–50 fields. Each value must be a string (up to 1,000 characters), number, boolean, or `null`. Fields you send are merged with existing values; send `null` or an empty string to remove a field.

```bash cURL theme={null}
curl -X PATCH "https://api.interviewflowai.com/api/external/custom-fields" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your_api_key_here" \
  -d '{
    "interviewId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "candidateAdditionalFields": {
      "score": 72,
      "review": "yes",
      "isSynced": true
    }
  }'
```

## Response

The response returns the interview ID and the Candidate's full set of additional fields after the update.

```json 200 theme={null}
{
  "data": {
    "interviewId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "candidateAdditionalFields": {
      "score": 72,
      "review": "yes",
      "isSynced": true
    }
  },
  "code": 200,
  "message": "Candidate additional fields updated successfully"
}
```

A missing interview, or one owned by another Company, returns `404 Not Found`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.