v1

latestOpenAPI 3.0.12026-08-063985821.3 MB

Candidate API:Availability

Update weekly availability

Set the candidates availability schedule for a single week

put/candidates/{candidateId}/availability/weekly

Path parameters

candidateIdinteger required

Candidate Id

Request body

weekOfstring date required

Update availability for the week (beginning Sunday) containing the specified date

recurringboolean

Availability repeats in following weeks. Previous/past recurring schedules will be terminated prior to this schedule, existing future overlapping schedules will be cancelled.

untilstring date nullable

Optional end date of repeating availability

Example request

{
  "weekOf": "2018-07-01",
  "availability": {
    "monday": [
      {
        "start": "09:00",
        "end": "12:00"
      },
      {
        "start": "13:00",
        "end": "17:00"
      }
    ],
    "tuesday": [
      {
        "start": "09:00",
        "end": "12:00"
      }
    ]
  },
  "recurring": true,
  "until": "2018-09-30"
}