Skip to content

Update an interview

Opportunities module

PATCH/interviews/{id}interviews.update

An interview or audition for an application. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability opportunities.application.review.
  • OAuth scopes: opportunities.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

interviews.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the interview.

Request body: InterviewUpdate

interviews.update: InterviewUpdate
FieldTypeRequiredDescription
scheduled_atstring (date-time)NoWhen it is scheduled.
interview_kind"Interview" | "Audition"NoInterview or Audition.
duration_minutesintegerNoLength in minutes.Constraints: range 1 to any
location_textstring | nullNoPlace or meeting link.Constraints: length 1 to 2000
internal_notestring | nullNoInternal note. Never visible externally.Constraints: length 1 to 20000
{
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Response 200: Interview

interviews.update: Interview
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the interview.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
application_idstring (uuid)YesIdentifier of the application.
scheduled_atstring (date-time)YesWhen it is scheduled.
interview_kind"Interview" | "Audition"YesInterview or Audition.
duration_minutesintegerYesLength in minutes.Constraints: range 1 to any
location_textstring | nullYesPlace or meeting link.Constraints: length 1 to 2000
internal_notestring | nullYesInternal note. Never visible externally.Constraints: length 1 to 20000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/interviews/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}'
const { data, etag } = await xos.interviews.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "scheduled_at": "2026-10-08T14:30:00Z",
    "interview_kind": "Interview",
    "duration_minutes": 30,
    "location_text": "Production office, Hall B",
    "internal_note": "Strong rigging resume."
  }, { ifMatch: etag });
response = xos.interviews.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"scheduled_at": "2026-10-08T14:30:00Z", "interview_kind": "Interview", "duration_minutes": 30, "location_text": "Production office, Hall B", "internal_note": "Strong rigging resume."}, if_match=etag)
xos interviews update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}' --if-match auto