Delete candidates from schedule

  • Updated on Apr 19, 2022
  • Published on Jun 30, 2021
  • 1 minute(s) read
Prev Next

Delete Candidates from schedule

DELETE /api/v1/integrations/external/schedule/{externalId}/candidates

Header

Name Data Type Description
Content-type: application/json for all requests
Authorization: EAPI {token} for all requests

Request Parameters

Parameters indicated with a * are mandatory

Parameter Type Description max length
externalId* Array [string] The external ID of the schedule

Request Parameters (for message body)

Parameters indicated with a * are mandatory

Parameter Type Description max length
Array* String External ids of candidates that need to be deleted

Sample Body Request

["EXT1","EXT3"]

Sample successfull Response

{
    "Content": {
        "DeletedCandidateExternalIds": [
            "EXT1"
        ],
        "NotFoundCandidateExternalIds": [],
        "NotFoundUserExternalIds": [
            "EXT3"
        ]
    },
    "Success": true,
    "Errors": null
}

Responses

Code Description
200 Successful operation
400 Possible errors:
Schedule hasn't been found by external id
Can’t update activated schedule
No external ids have been provided
No users were found by external ids
Scheduler hasn’t been set in External API settings
Selected scheduler no longer has permission to create, update and delete schedules
403 Not allowed to use external API
500 Internal server error