Skip to main content
PATCH
/
interviews
/
{id}
curl -X PATCH "https://app.usehindsight.com/api/v1/interviews/4821" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_context": {
      "title": "CTO",
      "evaluation_notes": "Completed 30-day POC, main concern is pricing"
    }
  }'

{
  "interview_request_id": 4821
}

Documentation Index

Fetch the complete documentation index at: https://docs.usehindsight.com/llms.txt

Use this file to discover all available pages before exploring further.

PATCH https://app.usehindsight.com/api/v1/interviews/{id}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Path parameter:
  id: integer  — the interview_request_id returned from POST /interviews

Request body (at least one field required):
{
  "contact_context": { ... } | "string",  // overwrites contact notes
  "contact_name": "Jane Smith",            // updates contact display name
  "objective": "string"                    // updates interview-specific goal
}

200 Response:
{
  "interview_request_id": 4821
}

Rate limits: 60 req/min (Essentials), 300 req/min (Growth), 1,000 req/min (Enterprise)

​
Overview

Use this endpoint to update context on an interview request after it has been created.
  • contact_context and contact_name update the contact record linked to the request. Context is stored in the contact’s notes field and included in every future interview prompt Paige runs for that contact.
  • objective updates the interview-specific goal on the request itself, giving Paige a targeted focus for this particular interview.
At least one field must be provided. Fields not included in the request are left unchanged.

​
Path Parameter

ParameterTypeDescription
idintegerThe interview_request_id returned when the interview was created via POST /interviews.

​
Request Body

FieldTypeDescription
contact_contextstring | objectUpdated context about the contact. Overwrites the existing contact notes — merge manually if you want to preserve prior context. Accepts a plain string or JSON object (serialized automatically).
contact_namestringUpdated display name for the contact.
objectivestringUpdated goal for this specific interview. Paige uses this when generating questions and conducting the conversation.
contact_context overwrites the contact’s existing notes rather than merging. If you want to preserve prior context, read the contact’s current notes first and include them in your update.

​
Response

FieldTypeDescription
interview_request_idintegerID of the updated interview request.

​
Rate Limits

PlanRequests per Minute
Essentials60
Growth300
Enterprise1,000

​
Examples

curl -X PATCH "https://app.usehindsight.com/api/v1/interviews/4821" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_context": {
      "title": "CTO",
      "evaluation_notes": "Completed 30-day POC, main concern is pricing"
    }
  }'

​
Error Responses

CodeDescription
bad_requestNo fields provided, or invalid JSON.
unauthorizedInvalid or missing API key.
not_foundInterview request not found, or it belongs to a different org.
rate_limit_exceededToo many requests. Check X-RateLimit-Reset and retry after.
{
  "error": {
    "code": "not_found",
    "message": "Interview request not found"
  }
}

Authorizations

​
Authorization
string
header
required

API key from Hindsight dashboard

Path Parameters

​
id
integer
required

The interview_request_id returned when the interview was created.

Body

application/json
​
contact_context

Updated context about the contact. Overwrites the existing contact notes. Used by Paige as background in every future interview prompt for this contact.

Example:
{
  "title": "CTO",
  "evaluation_notes": "Completed 30-day POC, main concern is pricing"
}
​
contact_name
string

Updated display name for the contact.

Example:

"Jane Smith"

​
objective
string

Updated goal for this specific interview.

Example:

"Focus on why pricing was a blocker vs. Competitor X"

Response

Interview request updated

​
interview_request_id
integer

ID of the updated interview request.

Example:

4821