Void Attempt

PUT /api/v1/integrations/external/schedule/{externalId}/void

Request Parameters

Parameters indicated with a * are mandatory

Parameter	Type	Description
externalId*	String	schedule external id.

Request Parameters (for message body)

Parameters indicated with a * are mandatory

Parameter	Type	Description
	Array [string]	External ids of candidates*

Sample Request

[‘7131’,’7140’]

Sample successfull Response

{
    "Content": [
        SuccessfullyUpdated: ["EXT1","EXT2"],
        Errors: [ 
        {
            "CandidateExtId": "EXT3",
            "Error": "User NOT found",
        },
        {
            "CandidateExtId": "EXT4",
            "Error": "Attempt cannot be started",
        }],
    "Success": true,
    "Errors": null
}

Responses

Code	Description
200	Successful operation
400	Possible error codes: Schedule has not been found Schedule is archived Schedule is not in progress Schedule is not activated
403	Not allowed to use external API
500	Internal server error