> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Update interview
> Update interview
**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.
## OpenAPI
````yaml PATCH /ats/applications/{application_id}/interviews
openapi: 3.1.0
info:
title: Kombo API
version: 1.0.0
servers:
- url: https://api.kombo.dev/v1
description: Kombo EU API
- url: https://api.us.kombo.dev/v1
description: Kombo US API
security:
- ApiKey: []
tags:
- name: General
- name: Kombo Connect
description: >-
Endpoints for Kombo Connect, our end-user-facing flow for setting up new
integrations.
- name: Unified HRIS API
description: Unified endpoints to access all the HR concepts you might need.
- name: Unified ATS API
description: Unified endpoints to access all the ATS concepts you might need.
- name: Unified ATS (Assessment & Background Check) API
description: >-
Unified endpoints to operate Assessments and Background Checks for many
applicant tracking systems.
- name: Unified LMS API
description: Unified endpoints to access all the LMS concepts you might need.
- name: AI Apply
description: Endpoints for AI-powered job application features.
- name: Custom Endpoints
description: Custom integration-specific endpoints.
paths:
/ats/applications/{application_id}/interviews:
patch:
tags:
- Unified ATS API
summary: Update interview
description: >+
Update interview
**Closed Beta Feature:** This endpoint is currently in closed
beta. We're testing it with selected customers before its public
release. If you're interested in learning more or getting early access,
please reach out.
operationId: PatchAtsApplicationsApplicationIdInterviews
parameters:
- in: header
name: X-Integration-Id
schema:
type: string
description: ID of the integration you want to interact with.
example: join:HWUTwvyx2wLoSUHphiWVrp28
required: true
- name: application_id
in: path
required: true
description: The ID of the application
schema:
$ref: >-
#/components/schemas/PatchAtsApplicationsApplicationIdInterviewsParameterApplicationId
requestBody:
description: PATCH /ats/applications/:application_id/interviews Request body
content:
application/json:
schema:
$ref: >-
#/components/schemas/PatchAtsApplicationsApplicationIdInterviewsRequestBody
responses:
'200':
description: PATCH /ats/applications/:application_id/interviews Positive response
content:
application/json:
schema:
$ref: >-
#/components/schemas/PatchAtsApplicationsApplicationIdInterviewsPositiveResponse
default:
$ref: '#/components/responses/ErrorResponseATS'
components:
schemas:
PatchAtsApplicationsApplicationIdInterviewsParameterApplicationId:
type: string
description: The ID of the application
PatchAtsApplicationsApplicationIdInterviewsRequestBody:
type: object
properties:
interview_id:
type: string
description: The ID of the interview
title:
type: string
description: The title of the interview
start_time:
type: string
description: The start time of the interview
end_time:
type: string
description: The end time of the interview
interviewer_user_ids:
type: array
items:
type: string
description: The IDs of the interviewers
organizer_user_id:
type: string
description: The ID of the organizer
location:
type: object
properties:
type:
type: string
enum:
- PHYSICAL
- VIRTUAL
address:
type: string
required:
- type
required:
- interview_id
- title
- start_time
- end_time
- interviewer_user_ids
- organizer_user_id
- location
PatchAtsApplicationsApplicationIdInterviewsPositiveResponse:
type: object
properties:
status:
type: string
const: success
data:
type: object
required:
- status
- data
responses:
ErrorResponseATS:
description: The standard error response with the error codes for the ATS use case.
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- error
error:
type: object
properties:
code:
type:
- string
- 'null'
enum:
- PLATFORM.RATE_LIMIT_EXCEEDED
- PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
- PLATFORM.INTEGRATION_NOT_FOUND
- PLATFORM.INPUT_INVALID
- PLATFORM.UNKNOWN_ERROR
- PLATFORM.IP_NOT_WHITELISTED
- PLATFORM.AUTHENTICATION_INVALID
- PLATFORM.TASK_TIMED_OUT
- INTEGRATION.PERMISSION_MISSING
- INTEGRATION.AUTHENTICATION_INVALID
- INTEGRATION.QA_FAILED
- INTEGRATION.SETUP_SYNC_PENDING
- INTEGRATION.SETUP_INCOMPLETE
- INTEGRATION.INACTIVE
- INTEGRATION.MODEL_NOT_AVAILABLE
- INTEGRATION.MODEL_DISABLED
- INTEGRATION.ACTION_NOT_AVAILABLE
- INTEGRATION.ACTION_DISABLED
- REMOTE.SERVICE_UNAVAILABLE
- REMOTE.RATE_LIMIT_EXCEEDED
- REMOTE.INPUT_INVALID
- REMOTE.UNKNOWN_HTTP_ERROR
- ATS.JOB_CLOSED
- ATS.APPLICATION_ALREADY_EXISTS
example: ATS.JOB_CLOSED
description: >-
Some errors include an error code that can be used to
identify their cause. See the [Error Handling
Docs](https://docs.kombo.dev/guides/errors) for more
information. For your error handling logic please use the
error `code` instead of other properties (e.g. message,
http status code, ...).
title:
type:
- string
- 'null'
description: A static, human-readable label.
message:
type: string
description: >-
A dynamic, detailed description of what went wrong in this
specific instance.
log_url:
type:
- string
- 'null'
format: uri
description: >-
The log page in the Kombo UI lists every interaction with
full details. If you need assistance, share that link with
our support team.
required:
- code
- title
- message
- log_url
description: Error details with structured code for programmatic handling.
required:
- status
- error
examples:
Error Response:
description: >-
When building error handling logic, always use the `code` field
to identify specific error types programmatically. See the
complete list of error codes in the
[docs](https://docs.kombo.dev/guides/errors).
value:
status: error
error:
code: INTEGRATION.MODEL_NOT_AVAILABLE
title: >-
This data model isn't supported for the selected
integration.
message: >-
The "employees" model is not yet available for Greenhouse.
Please reach out to Kombo if you need this functionality.
log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
Minimal Error Response:
description: >-
The "message" is always required while other fields can also be
`null`. See the [docs](https://docs.kombo.dev/guides/errors) for
more information.
value:
status: error
error:
code: null
title: null
message: The message is always in the response.
log_url: null
securitySchemes:
ApiKey:
type: http
scheme: bearer
description: >-
Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
in the Kombo dashboard.
````