API Reference

Requests invite update for automated self-schedule

post
https://api.smartrecruiters.com/self-scheduling/automated-self-schedules/update-invite

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
uuid
required
int32
required
15 to 1440

Self-scheduled interview duration in minutes

string
enum
required

Self-scheduled interview format

Allowed:
string

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

boolean
required
hiringTeamRoleToInterviewerIds
object
required
string

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

int32
1 to 14

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

reminders
array of objects
length between 0 and 5
reminders
communicationToCandidate
object
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?