Skip to main content
POST
/
job-interview-register-users
Register users for an interview
curl --request POST \
  --url https://cool.jobmojito.com/functions/v1/job-interview-register-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "name": "Peter Parker",
      "email": "jozo@jozo.sk",
      "external_id": "abcd"
    },
    {
      "name": "mr beast",
      "email": "hi@jozefbalaz.com"
    }
  ],
  "interview_id": "04e09fa5-3fb8-4236-b37d-fca2bcd1cb66",
  "merchant_id": "b5201178-46dd-4a20-a1af-7ffd647f834b",
  "send_email": true,
  "hide_menu": true,
  "hide_iframe": true,
  "is_test": true
}
'
import requests

url = "https://cool.jobmojito.com/functions/v1/job-interview-register-users"

payload = {
"users": [
{
"name": "Peter Parker",
"email": "jozo@jozo.sk",
"external_id": "abcd"
},
{
"name": "mr beast",
"email": "hi@jozefbalaz.com"
}
],
"interview_id": "04e09fa5-3fb8-4236-b37d-fca2bcd1cb66",
"merchant_id": "b5201178-46dd-4a20-a1af-7ffd647f834b",
"send_email": True,
"hide_menu": True,
"hide_iframe": True,
"is_test": True
}
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({
users: [
{name: 'Peter Parker', email: 'jozo@jozo.sk', external_id: 'abcd'},
{name: 'mr beast', email: 'hi@jozefbalaz.com'}
],
interview_id: '04e09fa5-3fb8-4236-b37d-fca2bcd1cb66',
merchant_id: 'b5201178-46dd-4a20-a1af-7ffd647f834b',
send_email: true,
hide_menu: true,
hide_iframe: true,
is_test: true
})
};

fetch('https://cool.jobmojito.com/functions/v1/job-interview-register-users', 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/job-interview-register-users",
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([
'users' => [
[
'name' => 'Peter Parker',
'email' => 'jozo@jozo.sk',
'external_id' => 'abcd'
],
[
'name' => 'mr beast',
'email' => 'hi@jozefbalaz.com'
]
],
'interview_id' => '04e09fa5-3fb8-4236-b37d-fca2bcd1cb66',
'merchant_id' => 'b5201178-46dd-4a20-a1af-7ffd647f834b',
'send_email' => true,
'hide_menu' => true,
'hide_iframe' => true,
'is_test' => true
]),
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/job-interview-register-users"

payload := strings.NewReader("{\n \"users\": [\n {\n \"name\": \"Peter Parker\",\n \"email\": \"jozo@jozo.sk\",\n \"external_id\": \"abcd\"\n },\n {\n \"name\": \"mr beast\",\n \"email\": \"hi@jozefbalaz.com\"\n }\n ],\n \"interview_id\": \"04e09fa5-3fb8-4236-b37d-fca2bcd1cb66\",\n \"merchant_id\": \"b5201178-46dd-4a20-a1af-7ffd647f834b\",\n \"send_email\": true,\n \"hide_menu\": true,\n \"hide_iframe\": true,\n \"is_test\": true\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/job-interview-register-users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {\n \"name\": \"Peter Parker\",\n \"email\": \"jozo@jozo.sk\",\n \"external_id\": \"abcd\"\n },\n {\n \"name\": \"mr beast\",\n \"email\": \"hi@jozefbalaz.com\"\n }\n ],\n \"interview_id\": \"04e09fa5-3fb8-4236-b37d-fca2bcd1cb66\",\n \"merchant_id\": \"b5201178-46dd-4a20-a1af-7ffd647f834b\",\n \"send_email\": true,\n \"hide_menu\": true,\n \"hide_iframe\": true,\n \"is_test\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cool.jobmojito.com/functions/v1/job-interview-register-users")

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 \"users\": [\n {\n \"name\": \"Peter Parker\",\n \"email\": \"jozo@jozo.sk\",\n \"external_id\": \"abcd\"\n },\n {\n \"name\": \"mr beast\",\n \"email\": \"hi@jozefbalaz.com\"\n }\n ],\n \"interview_id\": \"04e09fa5-3fb8-4236-b37d-fca2bcd1cb66\",\n \"merchant_id\": \"b5201178-46dd-4a20-a1af-7ffd647f834b\",\n \"send_email\": true,\n \"hide_menu\": true,\n \"hide_iframe\": true,\n \"is_test\": true\n}"

response = http.request(request)
puts response.read_body
[
  {
    "name": "<string>",
    "email": "<string>",
    "external_id": "<string>",
    "result": "ok",
    "interview_url": "<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"
}

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
users
object[]
required

Candidates to register for the interview. Each gets a one-time interview URL.

Example:
[
{
"name": "Peter Parker",
"email": "jozo@jozo.sk",
"external_id": "abcd"
},
{
"name": "mr beast",
"email": "hi@jozefbalaz.com"
}
]
interview_id
string<uuid>
required

Interview definition (interview_def_set) or position (position_def_set) id to register users for.

Minimum string length: 1
Example:

"04e09fa5-3fb8-4236-b37d-fca2bcd1cb66"

merchant_id
string<uuid> | null

Merchant id. Required when authenticating with the service key; for user tokens it is optional and only honored for admin / sub-merchant accounts.

Example:

"b5201178-46dd-4a20-a1af-7ffd647f834b"

send_email
boolean | null

Whether to send an invitation email to each registered candidate.

hide_menu

When true (or the string "true"), the interview UI hides its menu (view_hm).

hide_iframe

When true (or the string "true"), the interview UI hides its iframe chrome (view_hi).

is_test

When true (or the string "true"), mints a test token that can take a draft/unpublished interview and flags the result as a test.

Response

Per-user registration results.

name
string | null
email
string
external_id
string | null
result
string

"ok" on success, otherwise an "Error: ..." message for that user.

Example:

"ok"

interview_url
string

One-time interview URL containing the minted interview_token. Present only on success.

{key}
unknown