Skip to main content
POST
/
api
/
Interviews
/
{interviewId}
/
Preview
Get Interview Message Preview.
curl --request POST \
  --url https://api.example.com/api/Interviews/{interviewId}/Preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "candidateDistributionMode": 123,
  "clientDistributionMode": 123,
  "organizerId": 123,
  "typeId": 123,
  "dateInLocalTimeZone": "2023-11-07T05:31:56Z",
  "duration": 123,
  "timeZoneName": "<string>",
  "subject": "<string>",
  "location": "<string>",
  "locationTypeId": 123,
  "byPassTeamsLobby": true,
  "candidateTemplateId": 123,
  "clientTemplateId": 123,
  "candidateMessage": "<string>",
  "clientMessage": "<string>",
  "candidateId": 123,
  "jobId": 123,
  "users": [
    123
  ],
  "contacts": [
    123
  ],
  "filesToRemove": [
    123
  ]
}
'
{
  "value": 123
}

Path Parameters

interviewId
integer<int32>
required

Query Parameters

messageType
string
default:candidate
attendeeType
integer<int32>
default:0
attendeeId
integer<int32>
default:0

Body

application/json
candidateDistributionMode
integer<int32>
clientDistributionMode
integer<int32>
organizerId
integer<int32>
typeId
integer<int32>
dateInLocalTimeZone
string<date-time>
duration
integer<int32>
timeZoneName
string | null
subject
string | null
location
string | null
locationTypeId
integer<int32>
byPassTeamsLobby
boolean
candidateTemplateId
integer<int32>
clientTemplateId
integer<int32>
candidateMessage
string | null
clientMessage
string | null
candidateId
integer<int32>
jobId
integer<int32>
users
integer<int32>[] | null
contacts
integer<int32>[] | null
filesToRemove
integer<int32>[] | null

Response

200 - application/json

OK

value
integer<int32>