Contents x
    Delete candidates from schedule
    • 19 Apr 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Delete candidates from schedule

    • Updated on 19 Apr 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Delete Candidates from schedule

    DELETE /api/v1/integrations/external/schedule/{externalId}/candidates
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescriptionmax length
    externalId*Array [string]The external ID of the schedule

    Request Parameters (for message body)

    Parameters indicated with a * are mandatory

    ParameterTypeDescriptionmax length
    Array*StringExternal 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

    CodeDescription
    200Successful operation
    400Possible 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
    403Not allowed to use external API
    500Internal server error
    Was this article helpful?
    What's Next