Skip to main content
POST
Invite admin / merchant-team or coaching users

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
users
object[]
required

List of users to invite.

force_invite
boolean | null

When true, re-sends the invite email for still-pending (invited) profiles that did not otherwise produce a result.

Example:

false

merchant_id
string<uuid> | null

Target merchant id. Required with a service-role key; for admins / sub-merchant users it overrides the token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

mojito_language_code
enum<string> | null

Language code applied to created profiles (one of the platform-languages.json codes). Defaults to 'en' when omitted.

Available options:
ar,
bg,
zh,
hr,
cs,
da,
nl,
en,
fil,
fi,
fr,
de,
el,
hi,
hu,
id,
it,
ja,
ko,
ms,
no,
pl,
pt,
br,
ro,
ru,
sk,
es,
sv,
ta,
th,
tr,
uk,
vi
Example:

"en"

message_from_recruiter
string | null

Optional custom message included in the invitation email.

Response

The users array with per-item invitation results.

email
string
required
name
string | null
type
string | null
interview_id
string | null
result
string

Outcome, e.g. 'Invited', 'Activated', 'SubMerchantAdded', 'Skipped', or 'Error: '.

profile_id
string | null
profile_interview_id
string | null
{key}
unknown