v1

latestOpenAPI 3.0.12026-07-24285462499.1 KB
self-schedules

Requests invite update for automated self-schedule

Requests automated self-schedule update for candidate. Interview must NOT exist. If interview exists request self-reschedule must be used instead. Old link to self-schedule will be valid.

post/automated-self-schedules/update-invite

Request body

selfScheduleIdstring uuid
applicationIdstring uuid
durationInMinutesinteger

Self-scheduled interview duration in minutes

format'ONSITE_JOB' | 'ONSITE' | 'PHONE' | 'VIDEO' | 'VIDEO_CALENDAR' | 'VIDEO_MEETING_ZOOM' | 'OTHER'

Self-scheduled interview format

locationstring

Self-scheduled interview location. Depending on the format, can be empty or override default values. Per-format behavior ONSITE_JOB - if empty, job location would be used ONSITE - if empty, company location would be used PHONE, VIDEO - field is mandatory VIDEO_CALENDAR, VIDEO_MEETING_ZOOM - must be null or empty, link would be generated automatically OTHER - field is optional

privateInterviewboolean
hiringTeamRoleToInterviewerIdsobject
meetingHostIdstring

User ID that will be the host of the meeting. Required for format VIDEO_MEETING_ZOOM and VIDEO_CALENDAR

slotsAvailabilityLimitInDaysinteger

Defines how many days in the future the candidate can self-schedule

Example request

{
  "hiringTeamRoleToInterviewerIds": {
    "ANY": [
      "5f7b1b3b1d7f1d0001d7f1d0",
      "5f7b1b3b1d7f1d0001d7f1d1"
    ],
    "INTERVIEWER": [
      "00001b3b1d7f1d0001d73333"
    ],
    "HIRING_MANAGER": [
      "11111b3b1d7f1d0001d78888"
    ]
  },
  "meetingHostId": "5f7b1b3b1d7f1d0001d7f1d0"
}

Response

When self-schedule invite was updated successfully

object required