Client URL for new user

Based on the field type, this endpoint will:

a) When type is url, endpoint will generate a public interview URL for a specific user. This URL contains JWT token and specific user should be redirected to this URL.

b) When type is invitation, endpoint will generate public interview URL & subscribe the user to our email chain to receive an invitation email, reminder emails, and all notifications necessary to complete the interview.

curl --location --request POST 'https://cool.jobmojito.com/functions/v1/job-interview-register-users' \ --header 'Content-Type: application/json' \ --data-raw '{ "interview_id": "4316a76e-ab40-4dce-97fa-4db3f8caf3c4", "type": "url", "hide_menu": false, "users": [ { "name": "Peter Parker", "email": "peter@parker.com", "external_id": "abcd" }, { "name": "mr beast", "email": "hi@example.com" } ] }'

[ { "name": "Peter Parker", "email": "peter@parker.com", "external_id": "abcd", "interview_url": "https://....", "profile_interview_id": "19bd7229-7f5c-4686-917a-2687d3e6bae4", "result": "ok" }, { "name": "mr beast", "email": "hi@example.com", "result": "Error: ...." } ]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

interview_id

string

required

Id of the interview

type

enum<string>

required

Type of invitation

Allowed values:

urlinvitation

hide_menu

boolean

required

If set to true, interview portal menu items will be hidded

users

array [object {3}]

required

name

string

required

User full name

string

required

User email

external_id

string

optional

External user ID

Examples

Responses

🟢200Success

application/json

Body

array of:

name

string

required

Full user name (copy of the same value from request)

string

required

User email (copy of the same value from request)

external_id

string | null

optional

External user ID (copy of the same value from request)

interview_url

string

required

Frontend URL to which candidate should be redirected to

profile_interview_id

string

required

JobMojito internal profile_interview_id

result

string

required

Result of the invitation. Possible values:

ok - user has been invited

Error: .... : If error has been encoutered during the creation

🔴500Server error

🟠422Invalid input