Cancel Scheduling

Cancel Scheduled Candidates

post

Cancel scheduled candidates for a specific interview.

Authorizations

Path parameters

idstringRequired

The interview ID

Body

candidateEmailsstring · email[]RequiredExample: [e-mail]

Responses

200

Interview(s) cancelled

application/json

Responseall of

401

Missing or invalid Authorization header

application/json

404

Interview not found

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/interview/{id}/cancel-scheduled-candidates HTTP/1.1
Host: interview-api.zeko.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "candidateEmails": [
    "[e-mail]"
  ]
}

{
  "message": "Interview(s) cancelled",
  "success": true,
  "data": {
    "cancelledCandidates": [
      {
        "candidateEmail": "[e-mail]",
        "candidateName": "Rahul",
        "metaData": {
          "Id": 12345,
          "name": "012 - Tester",
          "clientId": 12434311
        }
      }
    ]
  }
}