> For the complete documentation index, see [llms.txt](https://zeko.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zeko.gitbook.io/docs/zekoai-api-docs/api-reference/ai-interview/interview-settings.md).

# Interview Settings

## Update Interview Settings

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

```json
{"openapi":"3.0.3","info":{"title":"ZekoAI Interview APIs","version":"1.0.0"},"servers":[{"url":"https://interview-api.zeko.ai","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UpdateInterviewSettingsRequest":{"type":"object","properties":{"interviewId":{"type":"string"},"interviewName":{"type":"string"},"interviewConfig":{"type":"object","properties":{"redirectUrl":{"type":"string","format":"uri"},"allowAccess":{"type":"string","enum":["anyone","scheduledCandidates"]},"allowLateAttempts":{"type":"boolean"},"allowContinueFromMiddle":{"type":"boolean"},"allowContinueFromMiddleCount":{"type":"integer"},"allowReattempt":{"type":"boolean"},"allowReattemptCount":{"type":"integer"},"allowInterviewOnMobile":{"type":"boolean"},"allowScreenLeaveCount":{"type":"integer"},"allowTabSwitchCount":{"type":"integer"},"webhookUrl":{"type":"string","format":"uri"}}},"metaData":{"type":"object","properties":{"Id":{"type":"integer"},"name":{"type":"string"},"clientId":{"type":"integer"}}},"published":{"type":"boolean"}}},"UpdateInterviewSettingsResponse":{"allOf":[{"$ref":"#/components/schemas/SuccessWrapper"},{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"interviewId":{"type":"string"},"interviewName":{"type":"string"},"roleName":{"type":"string"},"status":{"type":"string","enum":["draft","published","completed"]},"interviewLink":{"type":"string","nullable":true},"metaData":{"type":"object","properties":{"Id":{"type":"integer"},"name":{"type":"string"},"clientId":{"type":"integer"}}},"minExperience":{"type":"integer"},"maxExperience":{"type":"integer"},"jdType":{"type":"string","enum":["text","link"]},"sampleQuestions":{"type":"array","items":{"type":"string"}},"interviewConfig":{"type":"object","properties":{"redirectUrl":{"type":"string","format":"uri"},"allowAccess":{"type":"string","enum":["anyone","scheduledCandidates"]},"allowLateAttempts":{"type":"boolean"},"allowContinueFromMiddle":{"type":"boolean"},"allowContinueFromMiddleCount":{"type":"integer"},"allowReattempt":{"type":"boolean"},"allowReattemptCount":{"type":"integer"},"allowInterviewOnMobile":{"type":"boolean"},"allowScreenLeaveCount":{"type":"integer"},"allowTabSwitchCount":{"type":"integer"},"webhookUrl":{"type":"string","format":"uri"}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}]},"SuccessWrapper":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"object","description":"Actual response data object"}}},"ErrorWrapper":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"},"error":{"nullable":true,"description":"Error details: Error Message"}},"required":["message","success","error"]},"ValidationErrorWrapper":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}},"required":["message","success","error"]}}},"paths":{"/api/v1/interview/{id}/settings":{"put":{"tags":["Interview"],"summary":"Update Interview Settings","description":"Update the name, config, metadata, or publish status of an interview.","operationId":"updateInterviewSettings","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Interview ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInterviewSettingsRequest"}}}},"responses":{"200":{"description":"Interview settings updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInterviewSettingsResponse"}}}},"401":{"description":"Missing or invalid Authorization header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"404":{"description":"Interview not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"422":{"description":"Input Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}}}}}}}
```
