Sign in

v1

latestOpenAPI 3.0.12026-07-24285462499.1 KB
interview-templates

Create a interview template.

Creates a new interview template.

post/templates

Request body

templateNamestring required

Template name

templateType'INDIVIDUAL' | 'GROUP' required

Template type

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

privateInterviewboolean required

Flag indicating whether the interview invitation is private

Example request

{
  "templateName": "First interview template",
  "templateType": "GROUP",
  "hiringStage": "INTERVIEW",
  "hiringStep": "On-Site Interview",
  "customHiringStep": true,
  "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 created interview template.

templateIdstring uuid

Template id

templateNamestring

Template name

templateType'INDIVIDUAL' | 'GROUP'

Template type

hiringStagestring

Preferred hiring stage to which the template applies

hiringStepstring

Preferred hiring step to which the template applies

customHiringStepboolean

Custom Hiring step

privateInterviewboolean

Flag indicating whether the interview invitation is private

hiringTeamRoleToInterviewerCountobject

Required number of interviewers for given hiring team roles

isDefaultboolean

Flag indicating whether the template is one of the predefined ones

Example response

{
  "templateId": "b25e81c9-be09-4f5b-a54e-67476418c7ec",
  "templateName": "First interview template",
  "templateType": "GROUP",
  "hiringStage": "INTERVIEW",
  "hiringStep": "On-Site Interview",
  "privateInterview": true,
  "hiringTeamRoleToInterviewerCount": {
    "ANY": 1
  },
  "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"
    }
  ],
  "slotSetup": {
    "uniform": {
      "durationInMinutes": 30,
      "format": "OTHER",
      "location": "Office",
      "zoomHostId": "",
      "organizerId": "bd5d0eee-76ea-4f4c-9b0f-07f3a32b3ca5"
    }
  },
  "isDefault": true
}