Patch API

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.

Rate limit: 60 requests per minute per API key. Requests over the limit return 429 Too Many Requests.

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
    }
  }'

Getting Started

Main

Manage

Settings

Additional Platform Docs

For Candidates