;

Cancel Invitation

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

POST https://apiv3.imocha.io/v3/invitations/{testInvitationId}/cancel

Docs
Try it

Request URL Parameters

Field	Type	Required	Default	Description
testInvitationId	Integer64	Yes	-	Unique identifier given to each test attempt

Example API endpoint

URL 1: /v3/invitations/2932950/cancel

Successful response

Status 200 OK

Response
                                
     {  
     
        "testInvitationId":2932950,
        "status":"cancelled"
     }

Failed response

Status 400 Bad Request

If required parameters have invalid values.

Response
                        
    {
          "statusCode": 400,
          "message": "Testinvitation state in inprogress, complete, and expired can not be cancelled."
    }

x-api-key:

Parameter	Value	Description	Parameter Type	Data Type
testInvitationId		Unique identifier given to each test attempt	Query	Integer64

Response Body