Skip to main content
POST
/
api
/
Submissions
/
Preview
/
{candidateId}
Get Submission Message Preview.
curl --request POST \
  --url https://api.example.com/api/Submissions/Preview/{candidateId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobId": 123,
  "jobTitle": "<string>",
  "assignedToId": 123,
  "followUpAssignedToId": 123,
  "followUpDate": "2023-11-07T05:31:56Z",
  "clientDistributionModeID": 0,
  "submissionDate": "2023-11-07T05:31:56Z",
  "subject": "<string>",
  "body": "<string>",
  "sendCandidateConfirmation": true,
  "contacts": [
    123
  ],
  "candidateData": [
    {
      "id": 123,
      "cvId": 123,
      "videoLink": "<string>",
      "clientRate": "<string>",
      "candidateRate": "<string>",
      "availability": "<string>",
      "comments": "<string>",
      "candidateComments": "<string>",
      "complianceDocuments": [
        {
          "id": 123,
          "name": "<string>"
        }
      ]
    }
  ]
}
'
{
  "value": 123
}

Path Parameters

candidateId
integer<int32>
required

Query Parameters

contactId
integer<int32>
default:0

Body

application/json
jobId
integer<int32>
jobTitle
string | null
assignedToId
integer<int32>
followUpAssignedToId
integer<int32>
followUpDate
string<date-time> | null
clientDistributionModeID
enum<integer>
Available options:
0,
1,
2,
3
submissionDate
string<date-time>
subject
string | null
body
string | null
sendCandidateConfirmation
boolean
contacts
integer<int32>[] | null
candidateData
object[] | null

Response

200 - application/json

OK

value
integer<int32>