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
}
'
[
  {
    "name": "<string>",
    "email": "<string>",
    "external_id": "<string>",
    "result": "ok",
    "interview_url": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Supabase JWT access token, passed as 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