Interview Settings

Update Interview Settings

put

Update the name, config, metadata, or publish status of an interview.

Authorizations

Path parameters

idstringRequired

Interview ID

Body

interviewIdstringOptionalExample: 67f55dddb27e0a17d1228bf1

interviewNamestringOptionalExample: John Doe Updated

publishedbooleanOptionalExample: false

Responses

200

Interview settings updated

application/json

Responseall of

401

Missing or invalid Authorization header

application/json

404

Interview not found

application/json

422

Input Validation failed

application/json

500

Internal Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/interview/{id}/settings HTTP/1.1
Host: interview-api.zeko.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 498

{
  "interviewId": "67f55dddb27e0a17d1228bf1",
  "interviewName": "John Doe Updated",
  "interviewConfig": {
    "redirectUrl": "https://example.com/callback",
    "allowAccess": "anyone",
    "allowLateAttempts": true,
    "allowContinueFromMiddle": true,
    "allowContinueFromMiddleCount": 1,
    "allowReattempt": false,
    "allowReattemptCount": 0,
    "allowInterviewOnMobile": false,
    "allowScreenLeaveCount": 2,
    "allowTabSwitchCount": 2,
    "webhookUrl": "https://example.com/webhook"
  },
  "metaData": {
    "Id": 123,
    "name": "xyz",
    "clientId": 12434311
  },
  "published": false
}

{
  "message": "Interview settings updated successfully",
  "success": true,
  "data": {
    "interviewId": "67f55dddb27e0a17d1228bf1",
    "interviewName": "John Doe Updated",
    "roleName": "Software Engineer",
    "status": "draft",
    "interviewLink": "https://interview.zeko.ai/ai-interview/software-engineer9165921",
    "metaData": {
      "Id": 123,
      "name": "xyz",
      "clientId": 12434311
    },
    "minExperience": 3,
    "maxExperience": 13,
    "jdType": "text",
    "sampleQuestions": [
      "text"
    ],
    "interviewConfig": {
      "redirectUrl": "https://example.com/callback",
      "allowAccess": "anyone",
      "allowLateAttempts": true,
      "allowContinueFromMiddle": true,
      "allowContinueFromMiddleCount": 1,
      "allowReattempt": false,
      "allowReattemptCount": 0,
      "allowInterviewOnMobile": false,
      "allowScreenLeaveCount": 2,
      "allowTabSwitchCount": 2,
      "webhookUrl": "https://example.com/webhook"
    },
    "createdAt": "2025-08-26T17:02:52.897Z",
    "updatedAt": "2025-08-26T17:02:52.897Z"
  }
}