PUT Api/Applicant/{applicantId}/VideoInterviews

Creates an video interview for an applicant.

Request Information

URI Parameters

Name	Description	Type	Additional information
applicantId	Applicant ID	integer	Required

Body Parameters

Object with information about the applicant video interview

ApplicantVideoInterviewParameter

Name	Description	Type	Additional information
JobId	Id of the erecruiter job	integer	None.
ApplicationId	Id of the erecruiter application	integer	None.
Provider	Id of the video recruiter provider	VideoRecruitingProvider	None.
TemplateId	Template external id from the video recruiter provider	integer	None.
InterviewId	Interview external id from the video recruiter provider	integer	None.
InterviewDate	Date of interview	date	None.

Request Formats

application/json, text/json

Sample:

{
  "JobId": 1,
  "ApplicationId": 1,
  "Provider": 0,
  "TemplateId": 1,
  "InterviewId": 1,
  "InterviewDate": "2025-11-08T08:22:40.2143875+01:00"
}

application/xml, text/xml

Sample:

<ApplicantVideoInterviewParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <ApplicationId>1</ApplicationId>
  <InterviewDate>2025-11-08T08:22:40.2143875+01:00</InterviewDate>
  <InterviewId>1</InterviewId>
  <JobId>1</JobId>
  <Provider>None</Provider>
  <TemplateId>1</TemplateId>
</ApplicantVideoInterviewParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of applicant video interview.

Collection of ApplicantVideoInterviewResponse

Name	Description	Type	Additional information
ApplicantId	Applicant ID	integer	None.
JobId	Job ID (if available)	integer	None.
ApplicationId	Application ID (if available)	integer	None.
Provider	Video Recruiting Provider	VideoRecruitingProvider	None.
PlaybackUrl	URL to playback the video, valid for 3 playbacks.	URI	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ApplicantId": 1,
    "JobId": 1,
    "ApplicationId": 1,
    "Provider": 0,
    "PlaybackUrl": "http://webapihelppage2.com"
  },
  {
    "ApplicantId": 1,
    "JobId": 1,
    "ApplicationId": 1,
    "Provider": 0,
    "PlaybackUrl": "http://webapihelppage2.com"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApplicantVideoInterviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <ApplicantVideoInterviewResponse>
    <ApplicantId>1</ApplicantId>
    <ApplicationId>1</ApplicationId>
    <JobId>1</JobId>
    <PlaybackUrl>http://webapihelppage2.com/</PlaybackUrl>
    <Provider>None</Provider>
  </ApplicantVideoInterviewResponse>
  <ApplicantVideoInterviewResponse>
    <ApplicantId>1</ApplicantId>
    <ApplicationId>1</ApplicationId>
    <JobId>1</JobId>
    <PlaybackUrl>http://webapihelppage2.com/</PlaybackUrl>
    <Provider>None</Provider>
  </ApplicantVideoInterviewResponse>
</ArrayOfApplicantVideoInterviewResponse>