Ask a candidate for documents
curl --request POST \
--url https://cool.jobmojito.com/functions/v1/merchant-document-request-create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documents": [
{
"title": "<string>",
"description": "<string>",
"required": true,
"source_field_id": "<string>"
}
],
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"due_date": "<string>",
"notify": true,
"dry_run": false
}
'import requests
url = "https://cool.jobmojito.com/functions/v1/merchant-document-request-create"
payload = {
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documents": [
{
"title": "<string>",
"description": "<string>",
"required": True,
"source_field_id": "<string>"
}
],
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"due_date": "<string>",
"notify": True,
"dry_run": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidate_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
documents: [
{
title: '<string>',
description: '<string>',
required: true,
source_field_id: '<string>'
}
],
merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
message: '<string>',
due_date: '<string>',
notify: true,
dry_run: false
})
};
fetch('https://cool.jobmojito.com/functions/v1/merchant-document-request-create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cool.jobmojito.com/functions/v1/merchant-document-request-create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidate_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'documents' => [
[
'title' => '<string>',
'description' => '<string>',
'required' => true,
'source_field_id' => '<string>'
]
],
'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'application_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'message' => '<string>',
'due_date' => '<string>',
'notify' => true,
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cool.jobmojito.com/functions/v1/merchant-document-request-create"
payload := strings.NewReader("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cool.jobmojito.com/functions/v1/merchant-document-request-create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cool.jobmojito.com/functions/v1/merchant-document-request-create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"dry_run": true,
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify": true,
"email": "will_send",
"documents": [
{
"title": "<string>",
"required": true,
"sequence_no": 123,
"description": "<string>",
"source_field_id": "<string>"
}
],
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"candidate_name": "<string>",
"candidate_email": "<string>",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_name": "<string>",
"message": "<string>",
"due_date": "<string>"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}Document requests
Ask a candidate for documents
Asks a candidate to upload documents after applying (the document_requests feature): 1 to 10 documents, an optional message and due date, optionally for one of their applications. The candidate uploads them on their application page; you see them in list_document_requests. E-mail: with notify true (the default) the candidate gets “Documents requested” (the documents, your message, the due date, the position), and once more “Some documents are still missing” after the due date; nothing else is sent. Use dry_run first to check the input and see who would be e-mailed. Recorded on the candidate history. Position access applies (a candidate you may not see answers 404). Hiring managers are read only.
POST
/
merchant-document-request-create
Ask a candidate for documents
curl --request POST \
--url https://cool.jobmojito.com/functions/v1/merchant-document-request-create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documents": [
{
"title": "<string>",
"description": "<string>",
"required": true,
"source_field_id": "<string>"
}
],
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"due_date": "<string>",
"notify": true,
"dry_run": false
}
'import requests
url = "https://cool.jobmojito.com/functions/v1/merchant-document-request-create"
payload = {
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documents": [
{
"title": "<string>",
"description": "<string>",
"required": True,
"source_field_id": "<string>"
}
],
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"due_date": "<string>",
"notify": True,
"dry_run": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidate_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
documents: [
{
title: '<string>',
description: '<string>',
required: true,
source_field_id: '<string>'
}
],
merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
application_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
message: '<string>',
due_date: '<string>',
notify: true,
dry_run: false
})
};
fetch('https://cool.jobmojito.com/functions/v1/merchant-document-request-create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cool.jobmojito.com/functions/v1/merchant-document-request-create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidate_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'documents' => [
[
'title' => '<string>',
'description' => '<string>',
'required' => true,
'source_field_id' => '<string>'
]
],
'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'application_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'message' => '<string>',
'due_date' => '<string>',
'notify' => true,
'dry_run' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cool.jobmojito.com/functions/v1/merchant-document-request-create"
payload := strings.NewReader("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cool.jobmojito.com/functions/v1/merchant-document-request-create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cool.jobmojito.com/functions/v1/merchant-document-request-create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documents\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"source_field_id\": \"<string>\"\n }\n ],\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"application_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"due_date\": \"<string>\",\n \"notify\": true,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"dry_run": true,
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify": true,
"email": "will_send",
"documents": [
{
"title": "<string>",
"required": true,
"sequence_no": 123,
"description": "<string>",
"source_field_id": "<string>"
}
],
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"candidate_name": "<string>",
"candidate_email": "<string>",
"application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_name": "<string>",
"message": "<string>",
"due_date": "<string>"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}{
"error": "Field is required.",
"name": "interview_result_id"
}Authorizations
Supabase JWT — Authorization: Bearer <token>.
Body
application/json
The candidate to ask (profile_interview.id).
The documents to ask for, 1 to 10.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Optional company to act on. Admins and sub-merchant operators only; other callers always use their token's company.
Optional: the candidate's application this is for (position_result.id); the e-mail then names its position.
Message to the candidate, at most 2000 characters.
Maximum string length:
2000Due date (YYYY-MM-DD), today or later. After it the candidate is reminded once by e-mail (when notify is true).
Pattern:
^\d{4}-\d{2}-\d{2}$Default true: e-mail the candidate "Documents requested" now (and the one reminder after the due date). false: the request only shows on their application page.
true: check everything and answer who would be e-mailed, without creating the request or sending anything.
Response
The request (or, on a dry run, what it would be) and the e-mail outcome.
true when nothing was created or sent.
The candidate (profile_interview.id).
Whether the candidate is to be e-mailed.
The "Documents requested" e-mail: will_send (sent now, or at the time the company scheduled), not_requested (notify false), no_valid_email (the candidate has no usable address), suppressed (the company set this e-mail to Do not send).
Available options:
will_send, not_requested, no_valid_email, suppressed The documents as they are (or would be) stored.
Show child attributes
Show child attributes
The new request (profile_interview_document_request.id). Left out on a dry run.
Candidate's name, or e-mail when the name is empty.
The candidate's e-mail address, where the e-mail goes.
The application (position_result.id).
The application's position (position_def_set.id).
The position's name, as the e-mail shows it.
The message, trimmed.
The due date (YYYY-MM-DD).