SMsmartrecruiters
interview-templates

Update job interview template.

Updates job interview template.

put/interview/templates/job/{jobInterviewTemplateId}

Request

  • Base URL
    https://api.smartrecruiters.com/interview-templates
  • URL
    https://api.smartrecruiters.com/interview-templates/interview/templates/job/{jobInterviewTemplateId}
  • Auth
    • OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: interview_templates_manage
    • or API key in header x-smarttoken

Path parameters

jobInterviewTemplateIdstring uuid required

The job interview template id

Request body

durationInMinutesinteger required

Duration of the interview

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

privateInterviewboolean required

Flag indicating whether the interview invitation is private

zoomHostIdstring

Identifier of the user being the zoom interview host

organizerIdstring

Identifier of the user being the zoom interview organizer

meetingHostIdstring

Identifier of the user being the interview host

Example request

{
  "durationInMinutes": 60,
  "hiringTeamRoleToInterviewerCount": {
    "ANY": 4
  },
  "format": "PHONE",
  "location": "Tehama Street, San Francisco, CA",
  "privateInterview": true,
  "zoomHostId": "5f7b1b3b1d7f1d0001d7f1d0",
  "organizerId": "5f7b1b3b1d7f1d0001d7f1d0",
  "meetingHostId": "5f7b1b3b1d7f1d0001d7f1d0",
  "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
      },
      "line": {
        "content": "Hello, we would like to invite you to the interview",
        "confirmationMessage": "Thanks for the confirmation"
      },
      "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 job interview template.

Changes

No recorded changes to this operation across all 1 revision of this API.