> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jobmojito.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register users for an interview

> Registers (or updates) one or more candidate profiles for an interview and returns a one-time interview URL for each. Accepts a Supabase user JWT (merchant/admin) or the service key (merchant_id then required).



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi post /job-interview-register-users
openapi: 3.1.0
info:
  title: JobMojito API
  version: 1.0.0
  description: >-
    Public API for JobMojito, served by Supabase Edge Functions. Authenticate
    with a Supabase JWT access token via the Authorization header.
servers:
  - url: https://cool.jobmojito.com/functions/v1
    description: Production
security: []
tags:
  - name: Interviews
    description: >-
      Create, configure and manage interview / coaching / assessment
      definitions.
  - name: Results
    description: >-
      Interview results, transcripts, reports, re-attempt requests and
      analytics.
  - name: Candidates
    description: List and manage candidates.
  - name: Knowledge base
    description: Upload documents used to generate knowledge-base interviews.
  - name: Resume & Form verification
    description: Pre-screen candidates from resumes and forms.
  - name: Admin
    description: >-
      Account administration — invite team/coaching users, manage sub-merchants
      and avatar templates.
paths:
  /job-interview-register-users:
    post:
      tags:
        - Interviews
      summary: Register users for an interview
      description: >-
        Registers (or updates) one or more candidate profiles for an interview
        and returns a one-time interview URL for each. Accepts a Supabase user
        JWT (merchant/admin) or the service key (merchant_id then required).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobInterviewRegisterUsersRequest'
      responses:
        '200':
          description: Per-user registration results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobInterviewRegisterUsersResponse'
        '401':
          description: Unauthenticated user (user token with no resolvable user).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            Validation error (missing required fields, missing merchant_id with
            service key, or interview not found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error (includes authorization failures).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    JobInterviewRegisterUsersRequest:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/RegisterUser'
          description: >-
            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:
          type: string
          minLength: 1
          format: uuid
          description: >-
            Interview definition (interview_def_set) or position
            (position_def_set) id to register users for.
          example: 04e09fa5-3fb8-4236-b37d-fca2bcd1cb66
        merchant_id:
          type: string
          nullable: true
          format: uuid
          description: >-
            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:
          type: boolean
          nullable: true
          description: Whether to send an invitation email to each registered candidate.
        hide_menu:
          anyOf:
            - type: boolean
            - type: string
            - nullable: true
          description: >-
            When true (or the string "true"), the interview UI hides its menu
            (view_hm).
        hide_iframe:
          anyOf:
            - type: boolean
            - type: string
            - nullable: true
          description: >-
            When true (or the string "true"), the interview UI hides its iframe
            chrome (view_hi).
        is_test:
          anyOf:
            - type: boolean
            - type: string
            - nullable: true
          description: >-
            When true (or the string "true"), mints a test token that can take a
            draft/unpublished interview and flags the result as a test.
      required:
        - users
        - interview_id
    JobInterviewRegisterUsersResponse:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            nullable: true
          email:
            type: string
          external_id:
            type: string
            nullable: true
          result:
            type: string
            description: '"ok" on success, otherwise an "Error: ..." message for that user.'
            example: ok
          interview_url:
            type: string
            description: >-
              One-time interview URL containing the minted interview_token.
              Present only on success.
        additionalProperties:
          nullable: true
      description: >-
        The input users, each annotated with its registration result and (on
        success) interview URL.
    Error:
      type: object
      properties:
        error:
          type: string
          example: Field is required.
        name:
          type: string
          example: interview_result_id
      required:
        - error
    RegisterUser:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: Display name of the candidate.
          example: Peter Parker
        email:
          type: string
          nullable: true
          description: >-
            Email used to identify and invite the candidate. Validated per item,
            not request-level.
          example: jozo@jozo.sk
        external_id:
          type: string
          nullable: true
          description: Optional caller-supplied id, stored on the candidate profile.
          example: abcd
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT access token, passed as `Authorization: Bearer <token>`.'

````