API referenceOnboarding

Expire onboarding sessions by interviewIds.

POSThttps://demo-api.incodesmile.com/omni/expire/interviews

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

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

interviewIdsarray[string]

Configuration for expiring interview

expirationConditionsarray[string]required

enumINCOMPLETENEEDS_REVIEW

Responses

Response body (application/json)

successboolean

Flag indicating request passed successfully.

sessionStatusstring

Session status

enumAliveClosedDeleted

Language

Credentials

x-api-key

X-Incode-Hardware-Id

api-version

Stored only in your browser — sent straight to the Incode demo API, never to this site.

Request

curl -X POST https://demo-api.incodesmile.com/omni/expire/interviews \  -H "x-api-key: <YOUR_API_KEY>" \  -H "X-Incode-Hardware-Id: <YOUR_INCODE_HARDWARE_ID>" \  -H "api-version: 1.0" \  -H "Content-Type: application/json" \  -d '{    "cleanerConfiguration": {      "expirationConditions": []    }  }'

Fill the fields on the left to build the request.

Response

Click Try It ▶ to send a request and see the response here. Or choose an example:

application/json

Updated yesterday

Was this page helpful?