API reference · Onboarding

Expire onboarding sessions by interviewIds.

POST/omni/expire/interviews

Base URL: https://demo-api.incodesmile.com — Incode demo environment

Expire onboarding sessions given by interviewIds array, and cleanerConfiguration parameter.

Path & query parameters

Name In Type Required Description
api-version header string yes

Request body

Field Type Required Description
interviewIds array[string]
cleanerConfiguration ExpireInterviewConfigurationDto Configuration for expiring interview
cleanerConfiguration.expirationConditions array[string] yes

Responses

200

OK

Response body (application/json):

Field Type Required Description
success boolean Flag indicating request passed successfully.
sessionStatus string Session status Enum: Alive, Closed, Deleted
Was this page helpful?