---
title: "Requests invite update for automated self-schedule"
method: POST
path: "/automated-self-schedules/update-invite"
tags: ["self-schedules"]
---

# Requests invite update for automated self-schedule

`POST /automated-self-schedules/update-invite`

## Request

- Base URL: `https://api.smartrecruiters.com/self-scheduling`
- URL: `https://api.smartrecruiters.com/self-scheduling/automated-self-schedules/update-invite`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Client credentials
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `self_schedules_manage`
  - API key in header `x-smarttoken`

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.

## Request body

- AutomatedSelfScheduleUpdateInviteRequestDto
  - `selfScheduleId` string, uuid, required
  - `applicationId` string, uuid, required
  - `durationInMinutes` integer: Self-scheduled interview duration in minutes
  - `format` 'ONSITE_JOB' | 'ONSITE' | 'PHONE' | 'VIDEO' | 'VIDEO_CALENDAR' | 'VIDEO_MEETING_ZOOM' | 'OTHER', required: Self-scheduled interview format
  - `location` 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
  - `privateInterview` boolean
  - `hiringTeamRoleToInterviewerIds` object, required
  - `meetingHostId` string: User ID that will be the host of the meeting. Required for format VIDEO_MEETING_ZOOM and VIDEO_CALENDAR
  - `slotsAvailabilityLimitInDays` integer: Defines how many days in the future the candidate can self-schedule
  - `reminders` InterviewReminderDto[]
    - `channel` 'SMS' | 'WHATS_APP' | 'EMAIL' | 'LINE_ME', required: Reminder channel, can be SMS, WHATS_APP, LINE_ME or EMAIL
    - `advanceTimesInMinutes` integer[], required: List of times in minutes prior to interview for which the reminder will be sent
    - `reminderMessageTemplateId` string, required: Template ID for the reminder messages. Template must be of type INTERVIEW_REMINDER
  - `communicationToCandidate` CommunicationToCandidateDto
    - `emailMessageTemplateId` string, required: Template must be of type REQUEST_SELF_RESCHEDULE for reschedules and INVITATION_TO_SELF_SCHEDULE_UPDATED for self-schedule updates
    - `smartMessage` SmartMessageDto
      - `channel` 'WHATS_APP' | 'SMS' | 'LINE_ME', required
      - `messageTemplateId` string, required: Template must be of type REQUEST_SELF_RESCHEDULE for reschedules and INVITATION_TO_SELF_SCHEDULE_UPDATED for self-schedule updates
    - `repeat` PublicSelfScheduleRepeatInviteDto
      - `intervalInMinutes` integer
      - `count` integer

## Response `204`

When self-schedule invite was updated successfully

- object

## Other responses

- `400`: Incorrect input data
- `401`: Unauthorized

---

[API](https://skmtc.dev/smartrecruiters/apis/self-scheduling-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/self-scheduling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/self-scheduling-api/revisions/398fd477978f?raw)
