JobMojito

Invite user

POST

/invite-users

This endpoint will send invitations for a specific interview.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://cool.jobmojito.com/functions/v1/invite-users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "force_invite": false,
    "users": [
        {
            "name": "mr. Brown",
            "email": "hello@google.com",
            "type": "candidate",
            "interview_id": "d1c00b60-7e75-4292-9190-7037b95b349a"
        },
        {
            "name": "Peter Parker",
            "email": "jozo@jozo.sk",
            "type": "user"
        },
        {
            "name": "mr beast",
            "email": "hi@jozefbalaz.com",
            "type": "merchant"
        }
    ]
}'

Response Example

[
  {
    "name": "string",
    "email": "string",
    "type": "candidate",
    "interview_id": "string",
    "result": "Invited"
  }
]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

force_invite

boolean

required

When force_invite is false, invitation will be send to the candidate only once.

When force_invite is true, invitation will be send to the candidate every time, when this endpoint is called.

users

array [object {4}]

required

name

string

optional

User name

string

required

User email

type

enum<string>

required

Type of the account

Allowed values:

candidateusermentormerchantmerchant_owner

interview_id

string

optional

For candidates, interview_id is required

Examples

Responses

🟢200Success

application/json

Body

array of:

name

string

required

string

required

type

enum<string>

required

Allowed values:

candidateuser

interview_id

string

optional

result

enum<string>

required

Allowed values:

InvitedActivatedSkipped

Client URL for existing user

Interview result, details with transcript