Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Sequence

sequence.cancel

Cancels a running sourcing sequence (campaign) for a candidate.

Requires the sourcingWrite permission.

post/sequence.cancel

Request body

sequenceIdstring uuid required

The id of the sequence to cancel

reason'booked_meeting'

The reason for cancelling the sequence. Defaults to booked_meeting.

Example request

{
  "sequenceId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the sequence.cancel endpoint

OR

Example response

{
  "success": true,
  "results": {
    "sequenceId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
  }
}