Cancel Invitation

POST

/v3/invitations/{testInvitationId}/cancel

🔶 Cancel test invitation send to candidate

API Behavior

Invitation can only be canceled when it is in one of the below states:

Pending

Invitation can not be canceled when it is in one of the below states:

Inprogress
Complete
Expired
Canceled
Test Left
Terminated

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://apiv3.imocha.io/v3/invitations/{testInvitationId}/cancel' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
    "testInvitationId": 0,
    "status": "string"
}

Modified at 2025-08-19 13:32:43

Reattempt Test

List all test links