{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
Admin
Invite admin / merchant-team or coaching users
Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant’s available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 “Only users can invite users”, not 401 (kept for existing integrations).
Candidates only. false = add the candidates as prospects (no invitation e-mail, no credit used, interview_id not needed). Honoured only while the company's prospects feature is on; otherwise candidates are always invited.
Outcome, e.g. 'Invited', 'Activated', 'SubMerchantAdded' (administrative access to another merchant), 'CoachingAccessAdded' (learner access to another merchant's portal), 'ProspectAdded' (send_invitation false), 'Submitted' (a company on a shared candidate pool with send_invitation false: added to the parent's position without an e-mail), 'Skipped' (nothing done: the person already has this access, or see reason), or 'Error: '.
Why a row was skipped, when known: 'duplicate' = a company on a shared candidate pool, the candidate is already in the process through another channel; 'exists' = send_invitation false, the candidate already exists in the company (no prospect added).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"JobMojito Developer / Agent","description":"AI Interview and assessment conversational platform documentation","colors":{"primary":"#639C42","light":"#ACCC37","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=a05ab0ca109d7a225b08ccac00f9c486","href":"https://jobmojito.com"},"favicon":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=f300813ab120824238a790b6905dceee","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=2104ff9e7b9fd23fbe5954886c0aafbe"},"navbar":{"links":[{"href":"https://jobmojito.com/support","label":"Support"},{"href":"https://jobmojito.com","label":"Homepage"},{"href":"https://app.jobmojito.com","label":"App"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.mintlify.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/jobmojito"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jobmojito","hasAudioNarration":false,"actualSubdomain":"jobmojito","customDomains":["developer.jobmojito.com"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-jobmojito-fee23398","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af1dfb6ee06d45cdd87d014","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API Reference","count":82},{"language":"default","tag":"Admin","count":19},{"language":"default","tag":"Cookbooks","count":17},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"MCP","count":13},{"language":"default","tag":"Candidates","count":12},{"language":"default","tag":"Interviews","count":10},{"language":"default","tag":"Connect","count":8},{"language":"default","tag":"Reports","count":7},{"language":"default","tag":"Results","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/admin/invite-admin-merchant-team-or-coaching-users","slug":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users","pageMetadata":{"title":"Invite admin / merchant-team or coaching users","description":"Invites people to a merchant account and emails each one an invitation. Use it to add **admin / merchant-team users** who manage the recruiting dashboard (`merchant_owner`, `merchant`, `merchant_selection`), **coaching-portal users** (`user`, `mentor`), or **interview candidates** (`candidate`). Candidate invites require an `interview_id` and are gated by the merchant's available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \"Only users can invite users\", not 401 (kept for existing integrations).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /invite-users","href":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Invites people to a merchant account and emails each one an invitation. Use it to add \", _jsx(_components.strong, {\n children: \"admin / merchant-team users\"\n }), \" who manage the recruiting dashboard (\", _jsx(_components.code, {\n children: \"merchant_owner\"\n }), \", \", _jsx(_components.code, {\n children: \"merchant\"\n }), \", \", _jsx(_components.code, {\n children: \"merchant_selection\"\n }), \"), \", _jsx(_components.strong, {\n children: \"coaching-portal users\"\n }), \" (\", _jsx(_components.code, {\n children: \"user\"\n }), \", \", _jsx(_components.code, {\n children: \"mentor\"\n }), \"), or \", _jsx(_components.strong, {\n children: \"interview candidates\"\n }), \" (\", _jsx(_components.code, {\n children: \"candidate\"\n }), \"). Candidate invites require an \", _jsx(_components.code, {\n children: \"interview_id\"\n }), \" and are gated by the merchant’s available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 “Only users can invite users”, not 401 (kept for existing integrations).\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Invite admin / merchant-team or coaching users","description":"Invites people to a merchant account and emails each one an invitation. Use it to add **admin / merchant-team users** who manage the recruiting dashboard (`merchant_owner`, `merchant`, `merchant_selection`), **coaching-portal users** (`user`, `mentor`), or **interview candidates** (`candidate`). Candidate invites require an `interview_id` and are gated by the merchant's available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \"Only users can invite users\", not 401 (kept for existing integrations).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /invite-users","href":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Admin"],"summary":"Invite admin / merchant-team or coaching users","description":"Invites people to a merchant account and emails each one an invitation. Use it to add **admin / merchant-team users** who manage the recruiting dashboard (`merchant_owner`, `merchant`, `merchant_selection`), **coaching-portal users** (`user`, `mentor`), or **interview candidates** (`candidate`). Candidate invites require an `interview_id` and are gated by the merchant's available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \"Only users can invite users\", not 401 (kept for existing integrations).","security":["8936522b-50fc-4568-83e6-f2a1bc3abee4"],"requestBody":"b4593ce5-3a1e-4b38-b43b-69de9c67b6a1","responses":{"200":"556a23ae-9ac1-4251-ba56-2febb072cd57","401":"0d68c2b2-4460-412c-91f0-3425eb1e2f77","403":"1cc62ec8-96b3-4f83-868a-665dff17ced1","422":"c4e38c26-535d-4ac9-9509-d2069568a1dc","500":"11cb1db8-22b3-4f82-8616-b01f892e5978"},"method":"post","type":"path","servers":["454fcb62-7052-4847-a728-ecf5ade065a6"],"path":"/invite-users","baseUrlOptions":["https://cool.jobmojito.com/functions/v1"],"title":"Invite admin / merchant-team or coaching users","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"email":{"oneOf":[{"type":"string","description":"Email address of the person to invite. Validated per item; an invalid/missing value produces a per-item error result, not a request-level 422.","example":"hello@google.com","uniqueKey":"users.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the person to invite. Validated per item; an invalid/missing value produces a per-item error result, not a request-level 422.","example":"hello@google.com","uniqueKey":"users.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].email","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Display name for the invited profile.","example":"mr. Brown","uniqueKey":"users.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name for the invited profile.","example":"mr. Brown","uniqueKey":"users.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"Invite type — selects which kind of account is created. Defaults to 'user'. Admin / merchant-team roles (manage the recruiting dashboard): `merchant_owner`, `merchant`, `merchant_selection`. Coaching-portal users: `user`, `mentor`. Interview candidate: `candidate` (requires `interview_id`). An invalid value yields a per-item error result rather than a request-level failure.","enum":["user","mentor","merchant","merchant_owner","merchant_selection","candidate"],"example":"merchant","uniqueKey":"users.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Invite type — selects which kind of account is created. Defaults to 'user'. Admin / merchant-team roles (manage the recruiting dashboard): `merchant_owner`, `merchant`, `merchant_selection`. Coaching-portal users: `user`, `mentor`. Interview candidate: `candidate` (requires `interview_id`). An invalid value yields a per-item error result rather than a request-level failure.","enum":["user","mentor","merchant","merchant_owner","merchant_selection","candidate"],"example":"merchant","uniqueKey":"users.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"interview_id":{"oneOf":[{"type":"string","format":"uuid","description":"The interview (interview_def_set.id) or position (position_def_set.id) to invite to. Mandatory when type is 'candidate' (except prospects, see send_invitation).","example":"d1c00b60-7e75-4292-9190-7037b95b349a","uniqueKey":"users.items.[INDEX].interview_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The interview (interview_def_set.id) or position (position_def_set.id) to invite to. Mandatory when type is 'candidate' (except prospects, see send_invitation).","example":"d1c00b60-7e75-4292-9190-7037b95b349a","uniqueKey":"users.items.[INDEX].interview_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].interview_id","typeLabel":"string\u003cuuid> | null"},"phone":{"oneOf":[{"type":"string","description":"Candidates only: mobile number, international format preferred (E.164, e.g. +421903123456). Stored on a new candidate; on an existing candidate it only fills an empty phone and never overwrites one. Enables the SMS / WhatsApp notifications of interviews with candidate_notification_channel set.","example":"+421903123456","uniqueKey":"users.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Candidates only: mobile number, international format preferred (E.164, e.g. +421903123456). Stored on a new candidate; on an existing candidate it only fills an empty phone and never overwrites one. Enables the SMS / WhatsApp notifications of interviews with candidate_notification_channel set.","example":"+421903123456","uniqueKey":"users.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].phone","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"users.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"users.items.[INDEX].additionalProperties","typeLabel":"null"},"uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"description":"List of users to invite.","isRequired":true,"uniqueKey":"users","typeLabel":"object[]"},"force_invite":{"oneOf":[{"type":"boolean","description":"When true, re-sends the invite email for still-pending (invited) profiles that did not otherwise produce a result.","example":false,"uniqueKey":"force_invite.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, re-sends the invite email for still-pending (invited) profiles that did not otherwise produce a result.","example":false,"uniqueKey":"force_invite.oneOf.1","typeLabel":"null"}],"uniqueKey":"force_invite","typeLabel":"boolean | null"},"merchant_id":{"oneOf":[{"type":"string","format":"uuid","description":"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","uniqueKey":"merchant_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"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","uniqueKey":"merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_id","typeLabel":"string\u003cuuid> | null"},"mojito_language_code":{"oneOf":[{"type":"string","enum":["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"],"description":"Language code applied to created profiles (one of the listed codes). Defaults to 'en' when omitted.","example":"en","uniqueKey":"mojito_language_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["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"],"description":"Language code applied to created profiles (one of the listed codes). Defaults to 'en' when omitted.","example":"en","uniqueKey":"mojito_language_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"mojito_language_code","typeLabel":"enum\u003cstring> | null"},"message_from_recruiter":{"oneOf":[{"type":"string","description":"Optional custom message included in the invitation email.","uniqueKey":"message_from_recruiter.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional custom message included in the invitation email.","uniqueKey":"message_from_recruiter.oneOf.1","typeLabel":"null"}],"uniqueKey":"message_from_recruiter","typeLabel":"string | null"},"send_invitation":{"oneOf":[{"type":"boolean","description":"Candidates only. false = add the candidates as prospects (no invitation e-mail, no credit used, interview_id not needed). Honoured only while the company's prospects feature is on; otherwise candidates are always invited.","example":true,"uniqueKey":"send_invitation.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Candidates only. false = add the candidates as prospects (no invitation e-mail, no credit used, interview_id not needed). Honoured only while the company's prospects feature is on; otherwise candidates are always invited.","example":true,"uniqueKey":"send_invitation.oneOf.1","typeLabel":"null"}],"uniqueKey":"send_invitation","typeLabel":"boolean | null"},"source_note":{"oneOf":[{"type":"string","maxLength":200,"description":"With send_invitation false: where the prospects come from (stored as the campaign of their first-touch source).","example":"Job fair","uniqueKey":"source_note.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"description":"With send_invitation false: where the prospects come from (stored as the campaign of their first-touch source).","example":"Job fair","uniqueKey":"source_note.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_note","typeLabel":"string | null"}},"required":["users"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"users":[{"email":"hello@google.com","name":"mr. Brown","type":"merchant","interview_id":"d1c00b60-7e75-4292-9190-7037b95b349a","phone":"+421903123456"}],"force_invite":false,"merchant_id":"28106cba-1c27-4e53-b149-32113e5e8e31","mojito_language_code":"en","message_from_recruiter":"\u003cstring>","send_invitation":true,"source_note":"Job fair"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"556a23ae-9ac1-4251-ba56-2febb072cd57":{"description":"The users array with per-item invitation results.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].email","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].type","typeLabel":"string | null"},"interview_id":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].interview_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].interview_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].interview_id","typeLabel":"string | null"},"result":{"type":"string","description":"Outcome, e.g. 'Invited', 'Activated', 'SubMerchantAdded' (administrative access to another merchant), 'CoachingAccessAdded' (learner access to another merchant's portal), 'ProspectAdded' (send_invitation false), 'Submitted' (a company on a shared candidate pool with send_invitation false: added to the parent's position without an e-mail), 'Skipped' (nothing done: the person already has this access, or see reason), or 'Error: \u003cmessage>'.","uniqueKey":"items.[INDEX].result","typeLabel":"string"},"reason":{"type":"string","enum":["duplicate","exists"],"description":"Why a row was skipped, when known: 'duplicate' = a company on a shared candidate pool, the candidate is already in the process through another channel; 'exists' = send_invitation false, the candidate already exists in the company (no prospect added).","uniqueKey":"items.[INDEX].reason","typeLabel":"enum\u003cstring>"},"profile_id":{"oneOf":[{"type":"string","description":"The account (profile.id) invited or updated: team members, coaching users, and candidates who already have an account. Null otherwise.","uniqueKey":"items.[INDEX].profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The account (profile.id) invited or updated: team members, coaching users, and candidates who already have an account. Null otherwise.","uniqueKey":"items.[INDEX].profile_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].profile_id","typeLabel":"string | null"},"profile_interview_id":{"oneOf":[{"type":"string","description":"The candidate (profile_interview.id) for candidate rows. Null for team members and coaching users.","uniqueKey":"items.[INDEX].profile_interview_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The candidate (profile_interview.id) for candidate rows. Null for team members and coaching users.","uniqueKey":"items.[INDEX].profile_interview_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].profile_interview_id","typeLabel":"string | null"}},"required":["email"],"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].additionalProperties","typeLabel":"null"},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"description":"The input users array, each augmented with the invitation result fields.","uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"email":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","interview_id":"\u003cstring>","result":"\u003cstring>","reason":"duplicate","profile_id":"\u003cstring>","profile_interview_id":"\u003cstring>"}]}},"exampleType":"generated"}},"exampleType":"generated"},"0d68c2b2-4460-412c-91f0-3425eb1e2f77":{"description":"An expired or invalid access token reached the database.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"1cc62ec8-96b3-4f83-868a-665dff17ced1":{"description":"The caller may not invite (not an owner, recruiter or admin token, for example a hiring manager), does not have access to the requested merchant, or is not on the position (position access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"c4e38c26-535d-4ac9-9509-d2069568a1dc":{"description":"Validation error; merchant_id missing with the service key (\"merchant_id is required when using service key\"); or no signed-in user: a missing, invalid or expired user token, or a token that is neither a user token nor the service key (\"Only users can invite users\", kept as 422 rather than 401 for existing integrations).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"11cb1db8-22b3-4f82-8616-b01f892e5978":{"description":"Server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8936522b-50fc-4568-83e6-f2a1bc3abee4":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"454fcb62-7052-4847-a728-ecf5ade065a6":{"url":"https://cool.jobmojito.com/functions/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://cool.jobmojito.com/functions/v1/openapi"},"subdomain":"jobmojito","siteName":"JobMojito Developer / Agent","title":"Invite admin / merchant-team or coaching users - JobMojito Developer / Agent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T15:00:44.750Z","originalFileLocation":"api-reference/admin/invite-admin-merchant-team-or-coaching-users.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant\u0026#x27;s available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \u0026quot;Only users can invite users\u0026quot;, not 401 (kept for existing integrations).\">\u003cmeta data-mint-head name=\"application-name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Invite admin / merchant-team or coaching users - JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant\u0026#x27;s available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \u0026quot;Only users can invite users\u0026quot;, not 401 (kept for existing integrations).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Admin\u0026amp;title=Invite+admin+%2F+merchant-team+or+coaching+users\u0026amp;description=Invites+people+to+a+merchant+account+and+emails+each+one+an+invitation.+Use+it+to+add+**admin+%2F+merchant-team+users**+who+manage+the+recruiting+dashboard+%28%60merc\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=9d2841eb434f0ce06594ae4fce9832f7b8976a58769d45002460ed2ecc837e92\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Invite admin / merchant-team or coaching users - JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant\u0026#x27;s available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \u0026quot;Only users can invite users\u0026quot;, not 401 (kept for existing integrations).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Admin\u0026amp;title=Invite+admin+%2F+merchant-team+or+coaching+users\u0026amp;description=Invites+people+to+a+merchant+account+and+emails+each+one+an+invitation.+Use+it+to+add+**admin+%2F+merchant-team+users**+who+manage+the+recruiting+dashboard+%28%60merc\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=9d2841eb434f0ce06594ae4fce9832f7b8976a58769d45002460ed2ecc837e92\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#639C42\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/admin/invite-admin-merchant-team-or-coaching-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.jobmojito.com/#organization\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.jobmojito.com#website\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users#webpage\",\"url\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users\",\"name\":\"Invite admin / merchant-team or coaching users\",\"description\":\"Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant's available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \\\"Only users can invite users\\\", not 401 (kept for existing integrations).\",\"dateModified\":\"2026-11-09T15:00:44.750Z\",\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"JobMojito Developer / Agent\",\"item\":\"https://developer.jobmojito.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invite admin / merchant-team or coaching users\",\"item\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users#apireference\",\"headline\":\"Invite admin / merchant-team or coaching users\",\"name\":\"Invite admin / merchant-team or coaching users\",\"description\":\"Invites people to a merchant account and emails each one an invitation. Use it to add admin / merchant-team users who manage the recruiting dashboard (merchant_owner, merchant, merchant_selection), coaching-portal users (user, mentor), or interview candidates (candidate). Candidate invites require an interview_id and are gated by the merchant's available interview credits; admin and coaching invites are not. Each user in the array is processed independently and returned with an individual result, so one failure does not block the rest. Callable with a merchant JWT (merchant_owner/merchant/admin) or the service key itself (requires merchant_id); a token that only claims the service role is treated as a user token. Sends the invitation e-mails (and, for candidates with a phone and an interview with candidate_notification_channel, the SMS / WhatsApp messages); a prospect (send_invitation false) gets nothing. Note: a request without a signed-in user is answered with 422 \\\"Only users can invite users\\\", not 401 (kept for existing integrations).\",\"url\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users\",\"mainEntityOfPage\":{\"@id\":\"https://developer.jobmojito.com/api-reference/admin/invite-admin-merchant-team-or-coaching-users#webpage\"},\"dateModified\":\"2026-11-09T15:00:44.750Z\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"JobMojito Developer / Agent\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"JobMojito Developer / Agent\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users.md","siteName":"JobMojito Developer / Agent","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"Interviews","pages":[{"title":"Create a new interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create","href":"/api-reference/interviews/create-a-new-interview"},{"title":"Create an interview from an array of questions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-from-array","href":"/api-reference/interviews/create-an-interview-from-an-array-of-questions"},{"title":"Create an interview for a candidate and return an access token URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-for-candidate-with-token","href":"/api-reference/interviews/create-an-interview-for-a-candidate-and-return-an-access-token-url"},{"title":"Create a role-play — coaching persona or interview-portal role-play (choose with `portal`)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /persona-create","href":"/api-reference/interviews/create-a-role-play-—-coaching-persona-or-interview-portal-role-play-choose-with-`portal`"},{"title":"Get interview definition","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-get","href":"/api-reference/interviews/get-interview-definition"},{"title":"Update an interview or position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-update","href":"/api-reference/interviews/update-an-interview-or-position"},{"title":"Set interview state","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-set-state","href":"/api-reference/interviews/set-interview-state"},{"title":"Generate a signed interview URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-token","href":"/api-reference/interviews/generate-a-signed-interview-url"},{"title":"Register users for an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-register-users","href":"/api-reference/interviews/register-users-for-an-interview"},{"title":"List interview definitions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-interview-list","href":"/api-reference/interviews/list-interview-definitions"}]},{"group":"Positions","pages":[{"title":"Set the steps of a draft position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-process-save","href":"/api-reference/positions/set-the-steps-of-a-draft-position"},{"title":"Change the settings of a position step","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-step-update","href":"/api-reference/positions/change-the-settings-of-a-position-step"},{"title":"Create, change or delete a meeting slot","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-meeting-slot-manage","href":"/api-reference/positions/create-change-or-delete-a-meeting-slot"},{"title":"Copy a position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-duplicate","href":"/api-reference/positions/copy-a-position"},{"title":"Copy an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-interview-duplicate","href":"/api-reference/positions/copy-an-interview"}]},{"group":"Coaching catalogue","pages":[{"title":"Create a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-create","href":"/api-reference/coaching-catalogue/create-a-coaching-catalogue-directory"},{"title":"Update a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-update","href":"/api-reference/coaching-catalogue/update-a-coaching-catalogue-directory"},{"title":"Get a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-get","href":"/api-reference/coaching-catalogue/get-a-coaching-catalogue-directory"},{"title":"List coaching catalogue directories","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-list","href":"/api-reference/coaching-catalogue/list-coaching-catalogue-directories"}]},{"group":"Results","pages":[{"title":"Get interview result details with transcript","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-details","href":"/api-reference/results/get-interview-result-details-with-transcript"},{"title":"Generate an interview report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pdf","href":"/api-reference/results/generate-an-interview-report"},{"title":"Request another interview attempt","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-result-request-another-attempt","href":"/api-reference/results/request-another-interview-attempt"},{"title":"Record an external assessment result","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /assessment-result-set","href":"/api-reference/results/record-an-external-assessment-result"},{"title":"List interview results","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-result-list","href":"/api-reference/results/list-interview-results"},{"title":"Get daily event analytics","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics","href":"/api-reference/results/get-daily-event-analytics"},{"title":"Get merchant credit usage","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics-credits-used","href":"/api-reference/results/get-merchant-credit-usage"}]},{"group":"Reports","pages":[{"title":"List report datasets, fields and measures","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-catalog","href":"/api-reference/reports/list-report-datasets-fields-and-measures"},{"title":"List custom reports","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-list","href":"/api-reference/reports/list-custom-reports"},{"title":"Get a custom report definition","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-get","href":"/api-reference/reports/get-a-custom-report-definition"},{"title":"Run a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-run","href":"/api-reference/reports/run-a-custom-report"},{"title":"Check and run an unsaved report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-preview","href":"/api-reference/reports/check-and-run-an-unsaved-report"},{"title":"Create a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-create","href":"/api-reference/reports/create-a-custom-report"},{"title":"Update a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-update","href":"/api-reference/reports/update-a-custom-report"}]},{"group":"Candidates","pages":[{"title":"List candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-list","href":"/api-reference/candidates/list-candidates"},{"title":"Get a candidate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-get","href":"/api-reference/candidates/get-a-candidate"},{"title":"Add a note to a candidate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-note-add","href":"/api-reference/candidates/add-a-note-to-a-candidate"},{"title":"Tag candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tags-set","href":"/api-reference/candidates/tag-candidates"},{"title":"Create, change or delete a candidate tag","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tag-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-tag"},{"title":"List candidate filter options","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-filter-options","href":"/api-reference/candidates/list-candidate-filter-options"},{"title":"Preview merging two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-merge-preview","href":"/api-reference/candidates/preview-merging-two-candidates"},{"title":"Merge two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-merge","href":"/api-reference/candidates/merge-two-candidates"},{"title":"Dismiss a possible duplicate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-duplicate-dismiss","href":"/api-reference/candidates/dismiss-a-possible-duplicate"},{"title":"List candidate segments","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-segment-list","href":"/api-reference/candidates/list-candidate-segments"},{"title":"Create, change or delete a candidate segment","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-segment-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-segment"},{"title":"Download a candidate document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-download","href":"/api-reference/candidates/download-a-candidate-document"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-task-list","href":"/api-reference/tasks/list-tasks"},{"title":"Create or change a task","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-task-save","href":"/api-reference/tasks/create-or-change-a-task"}]},{"group":"Document requests","pages":[{"title":"List document requests","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-request-list","href":"/api-reference/document-requests/list-document-requests"},{"title":"Ask a candidate for documents","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-create","href":"/api-reference/document-requests/ask-a-candidate-for-documents"},{"title":"Cancel a document request or mark it reviewed","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-update","href":"/api-reference/document-requests/cancel-a-document-request-or-mark-it-reviewed"}]},{"group":"Reasons","pages":[{"title":"List the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-list","href":"/api-reference/reasons/list-the-companys-reasons"},{"title":"Get one of the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-get","href":"/api-reference/reasons/get-one-of-the-companys-reasons"},{"title":"Create, change or archive a reason","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-reason-save","href":"/api-reference/reasons/create-change-or-archive-a-reason"}]},{"group":"Knowledge base","pages":[{"title":"Upload a knowledge base document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-upload","href":"/api-reference/knowledge-base/upload-a-knowledge-base-document"},{"title":"List knowledge base documents and their interview limits","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-document-list","href":"/api-reference/knowledge-base/list-knowledge-base-documents-and-their-interview-limits"},{"title":"Change which interviews can use a document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-set-interviews","href":"/api-reference/knowledge-base/change-which-interviews-can-use-a-document"},{"title":"List knowledge base stores","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-store-list","href":"/api-reference/knowledge-base/list-knowledge-base-stores"},{"title":"Create or change a knowledge base store","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-store-save","href":"/api-reference/knowledge-base/create-or-change-a-knowledge-base-store"}]},{"group":"Resume \u0026 Form verification","pages":[{"title":"Create or update a pre-screening position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /pre-screening-create","href":"/api-reference/resume-\u0026-form-verification/create-or-update-a-pre-screening-position"},{"title":"Run pre-screening on a plaintext resume","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-text","href":"/api-reference/resume-\u0026-form-verification/run-pre-screening-on-a-plaintext-resume"},{"title":"Pre-screen a candidate from a binary resume upload","description":"Accepts a multipart/form-data upload with candidate details and a binary resume file, converts the resume to text, runs AI pre-screening against the position, stores the result, and returns the decision.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-binary","href":"/api-reference/resume-\u0026-form-verification/pre-screen-a-candidate-from-a-binary-resume-upload"}]},{"group":"Admin","pages":[{"title":"Invite admin / merchant-team or coaching users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /invite-users","href":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users"},{"title":"List sub-merchants","description":"Paginated list of the sub-merchants the caller administers (the admin-portal sub-merchants list). Visibility is enforced by row-level security. Capped at 1000 records per page.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-sub-merchant-list","href":"/api-reference/admin/list-sub-merchants"},{"title":"List the company's users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-user-list","href":"/api-reference/admin/list-the-companys-users"},{"title":"List avatar templates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-avatar-list","href":"/api-reference/admin/list-avatar-templates"},{"title":"Get merchant status","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-status","href":"/api-reference/admin/get-merchant-status"},{"title":"List platform languages","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /platform-languages-list","href":"/api-reference/admin/list-platform-languages"},{"title":"Get the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-configuration-get","href":"/api-reference/admin/get-the-portal-configuration-branding-portals-brands-pages"},{"title":"Update the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-configuration-update","href":"/api-reference/admin/update-the-portal-configuration-branding-portals-brands-pages"},{"title":"Publish a brand stylesheet","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-css-publish","href":"/api-reference/admin/publish-a-brand-stylesheet"},{"title":"Get the component style guide","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-component-styles","href":"/api-reference/admin/get-the-component-style-guide"},{"title":"Save a component style","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles","href":"/api-reference/admin/save-a-component-style"},{"title":"Generate component style alternatives","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles-generate","href":"/api-reference/admin/generate-component-style-alternatives"},{"title":"List the media library","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-list","href":"/api-reference/admin/list-the-media-library"},{"title":"Start uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-start","href":"/api-reference/admin/start-uploading-a-media-file"},{"title":"Finish uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-finish","href":"/api-reference/admin/finish-uploading-a-media-file"},{"title":"Describe a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-update","href":"/api-reference/admin/describe-a-media-file"},{"title":"Delete a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-delete","href":"/api-reference/admin/delete-a-media-file"},{"title":"List the media library folders","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-folders","href":"/api-reference/admin/list-the-media-library-folders"},{"title":"Create, rename or delete a media library folder","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-folders","href":"/api-reference/admin/create-rename-or-delete-a-media-library-folder"}]},{"group":"Feedback","pages":[{"title":"Submit a feature request","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-feature-request","href":"/api-reference/feedback/submit-a-feature-request"},{"title":"Report a technical issue","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-technical-issue","href":"/api-reference/feedback/report-a-technical-issue"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/interview-result-submitted"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Invite admin / merchant-team or coaching users - JobMojito Developer / Agent","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}