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

# saveOnboarding

> Atomically persists a member's onboarding payload – profile metadata, interest selections, and completion flags – while enforcing validation rules and idempotency. The mutation uses a scoped idempotency key so the same payload can be retried without duplicating interests or profiles.



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/users/mutations/saveOnboarding
openapi: 3.0.3
info:
  title: Connvo Convex API
  version: 1.0.0
  description: >-
    HTTP interface for Connvo's Convex backend, exposing vetted query, mutation,
    and action endpoints.
servers:
  - url: https://Connvo-dev.convex.cloud
    description: Dev Convex deployment
  - url: https://Connvo-staging.convex.cloud
    description: Staging Convex deployment
  - url: https://Connvo-prod.convex.cloud
    description: Prod Convex deployment
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Identity, profile, and authentication operations for Connvo users.
  - name: Meetings
    description: Scheduling, managing, and retrieving meeting data.
  - name: Transcripts
    description: Endpoints for accessing call transcripts and transcription controls.
  - name: Insights
    description: AI-generated insights, summaries, and analytics derived from meetings.
  - name: Prompts
    description: Prompt management and AI conversation guidance.
  - name: Notes
    description: Collaborative meeting notes and follow-up documentation.
  - name: WebRTC
    description: Real-time communication, session signalling, and media utilities.
  - name: System
    description: General system endpoints such as health checks and diagnostics.
paths:
  /api/run/users/mutations/saveOnboarding:
    post:
      tags:
        - Users
      summary: saveOnboarding
      description: >-
        Atomically persists a member's onboarding payload – profile metadata,
        interest selections, and completion flags – while enforcing validation
        rules and idempotency. The mutation uses a scoped idempotency key so the
        same payload can be retried without duplicating interests or profiles.
      operationId: postApiRunUsersMutationsSaveOnboarding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Request_users.mutations.saveOnboarding'
            example:
              args:
                age: 25
                gender: prefer-not-to-say
                field: Software
                jobTitle: Engineer
                company: Acme
                linkedinUrl: https://linkedin.com/in/test
                bio: Hello, I build things.
                interests:
                  - id: software-engineering
                    name: Software Engineering
                    category: industry
                  - id: startups
                    name: Startups
                    category: personal
                idempotencyKey: onboarding-test-user
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_users.mutations.saveOnboarding'
              example:
                status: success
                errorMessage: ''
                errorData: {}
                value:
                  userId: user_9f3c2ab457
                  profileId: profiles_d4c1e87a90
                  interestsCount: 2
                  onboardingCompleted: true
        '400':
          description: Failed operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
        '500':
          description: Convex Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Request_users.mutations.saveOnboarding:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - age
            - bio
            - company
            - field
            - gender
            - interests
            - jobTitle
          properties:
            age:
              type: number
            bio:
              type: string
            company:
              type: string
            field:
              type: string
            gender:
              oneOf:
                - type: string
                  enum:
                    - male
                - type: string
                  enum:
                    - female
                - type: string
                  enum:
                    - non-binary
                - type: string
                  enum:
                    - prefer-not-to-say
            idempotencyKey:
              type: string
            interests:
              type: array
              items:
                type: object
                required:
                  - category
                  - id
                  - name
                properties:
                  category:
                    oneOf:
                      - type: string
                        enum:
                          - academic
                      - type: string
                        enum:
                          - industry
                      - type: string
                        enum:
                          - skill
                      - type: string
                        enum:
                          - personal
                  iconName:
                    type: string
                  id:
                    type: string
                  name:
                    type: string
            jobTitle:
              type: string
            linkedinUrl:
              type: string
    Response_users.mutations.saveOnboarding:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - interestsCount
            - onboardingCompleted
            - profileId
            - userId
          properties:
            interestsCount:
              type: number
            onboardingCompleted:
              type: boolean
            profileId:
              type: string
              description: ID from table "profiles"
            userId:
              type: string
              description: ID from table "users"
    FailedResponse:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Standard user authentication token issued via WorkOS. Provide as
        `Authorization: Bearer <user-token>`.

````