Sign in

v1

latestOpenAPI 3.0.12026-07-24285462499.1 KB
interview-templates

Update interview template by id.

Updates interview template by id. Deprecated: use PUT /public-api/templates/{id} instead.

put/interview/templates/{id}

Path parameters

idstring uuid required

The interview template id.

Request body

templateNamestring required

Template name

durationInMinutesinteger required

Duration of the interview

hiringStagestring

Preferred hiring stage to which the template applies

hiringStepstring

Preferred hiring step to which the template applies

customHiringStepboolean

Indicates that this is a custom hiring step and can be applied to any step

hiringTeamRoleToInterviewerCountobject required

Required number of interviewers for given hiring team roles

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

Format of the interview

locationstring

Location of the interview

zoomHostIdstring

Identifier of the user being the zoom interview host. Deprecated due to irrelevant and therefore no substitution is needed.

organizerIdstring

Identifier of the user being the zoom interview organizer. Deprecated due to irrelevant and therefore no substitution is needed.

privateInterviewboolean required

Flag indicating whether the interview invitation is private

Example request

{
  "templateName": "First interview template",
  "durationInMinutes": 60,
  "hiringStage": "INTERVIEW",
  "hiringStep": "On-Site Interview",
  "customHiringStep": true,
  "format": "PHONE",
  "location": "56 Tehama Street, San Francisco, CA",
  "zoomHostId": "5f7b1b3b1d7f1d0001d7f1d0",
  "organizerId": "5f7b1b3b1d7f1d0001d7f1d0",
  "privateInterview": true,
  "invitations": [
    {
      "email": {
        "subject": "Interview invitation",
        "content": "You have been invited for an interview"
      },
      "sms": {
        "content": "Hello, we would like to invite you to the interview",
        "confirmationMessage": "Thanks for the confirmation"
      },
      "whatsApp": {
        "enabled": true
      },
      "language": "en",
      "repeat": {
        "intervalInMinutes": 1440,
        "count": 2
      }
    }
  ],
  "reminders": [
    {
      "language": "en",
      "message": {
        "content": "Hello, we would like to remind you about upcoming interview."
      }
    }
  ]
}

Response

Successfully updated interview template.

templateIdstring uuid

Template id

templateNamestring

Template name

durationInMinutesinteger

Duration of the interview

hiringStagestring

Preferred hiring stage to which the template applies

hiringStepstring

Preferred hiring step to which the template applies

hiringTeamRoleToInterviewerCountobject

Required number of interviewers for given hiring team roles

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

Format of the interview

locationstring

Location of the interview

privateInterviewboolean

Flag indicating whether the interview invitation is private

zoomHostIdstring

Identifier of the user being the zoom interview host. Deprecated due to irrelevant and therefore no substitution is needed.

organizerIdstring

Identifier of the user being the zoom interview organizer. Deprecated due to irrelevant and therefore no substitution is needed.

isDefaultboolean

Flag indicating whether the template is one of the predefined ones

Example response

{
  "templateId": "b25e81c9-be09-4f5b-a54e-67476418c7ec",
  "templateName": "First interview template",
  "durationInMinutes": 60,
  "hiringStage": "INTERVIEW",
  "hiringStep": "On-Site Interview",
  "hiringTeamRoleToInterviewerCount": {
    "ANY": 1
  },
  "format": "PHONE",
  "location": "56 Tehama Street, San Francisco, CA",
  "privateInterview": true,
  "zoomHostId": "5f7b1b3b1d7f1d0001d7f1d0",
  "organizerId": "5f7b1b3b1d7f1d0001d7f1d0",
  "invitations": [
    {
      "email": {
        "subject": "Interview invitation",
        "content": "You have been invited for an interview"
      },
      "sms": {
        "content": "You have been invited for an interview",
        "confirmationMessage": "Thanks for the confirmation"
      },
      "whatsApp": {
        "enabled": true
      },
      "language": "en",
      "repeat": {
        "intervalInMinutes": 1440,
        "count": 2
      }
    }
  ],
  "reminders": [
    {
      "message": {
        "subject": "Upcoming interview reminder",
        "content": "Hello, we would like to remind you about upcoming interview."
      },
      "language": "en"
    }
  ],
  "isDefault": true
}