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

# Record an externally-achieved exam result on a learner's enrolment



## OpenAPI

````yaml /openapi.json post /certifications/{uuid}/enrollments/result
openapi: 3.1.0
info:
  title: Journeybee API
  description: >-
    Public REST API for the Journeybee PRM platform.


    Manage partners, leads, deals, products, pricing calculators, tasks, and
    more programmatically.


    All endpoints require authentication via API key. Use `Authorization: Bearer
    <api_key>` or `Api-Key <api_key>` header.


    See the [Authentication guide](/guides/authentication) for details.
  version: 1.0.0
servers:
  - url: https://api.journeybee.io/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: >-
      Authenticated company account info, API key permissions, and enabled
      modules
  - name: Agreement Templates
  - name: Agreements
  - name: Analytics
    description: >-
      Dashboard analytics and reporting — commission, engagement, LMS, and
      partner revenue metrics
  - name: Assets
    description: File and media asset management
  - name: Attributions
    description: Attribution type definitions
  - name: Audit Log
    description: Unified audit log of company activity (read-only)
  - name: Automations
    description: Workflow automation rule configurations
  - name: Campaign Audience
    description: Audience filters on a campaign
  - name: Campaign Partners
    description: Partners shared into a campaign audience
  - name: Campaigns
    description: Partner marketing campaigns
  - name: Card Assignees
    description: Assigned users on a card
  - name: Card Partners
    description: Partners linked to a card
  - name: Card Tags
    description: Tags on a card
  - name: Cards
    description: Kanban project cards
  - name: Categories
    description: Partner categories
  - name: Certification Categories
    description: Categories on a certification
  - name: Certification Enrollments
    description: User enrollments in a certification
  - name: Certification Folders
    description: Folders on a certification
  - name: Certification Resources
    description: Curriculum resources in a certification
  - name: Certification Translations
  - name: Certifications
    description: LMS certifications
  - name: Commissions
    description: >-
      Commission rule configurations with calculation entries,
      tier/category/partnership scoping
  - name: Contacts
    description: Partner contacts across partnerships
  - name: Currencies
    description: Available currencies
  - name: Custom Field Options
    description: Options on select/multi-select custom fields
  - name: Custom Field Rules
    description: Visibility and requirement rules on custom fields
  - name: Custom Field Values
    description: Custom field values
  - name: Custom Fields
    description: Custom field definitions
  - name: Deal Commission
    description: Commission calculation on a deal
  - name: Deal Custom Field Values
    description: Custom field values on a deal
  - name: Deal Notes
    description: Notes on a deal
  - name: Deal Partner Roles
    description: Roles a supporting (co-sell) partner can hold on a deal
  - name: Deal Partners
    description: Supporting (co-sell) partners on a deal
  - name: Deal Payments
    description: Payment records on a deal (read-only)
  - name: Deal Products
    description: Products attached to a deal
  - name: Deal Stages
    description: Deal pipeline stages
  - name: Deal Tags
    description: Tags on a deal
  - name: Deal Tasks
    description: Tasks on a deal
  - name: Deals
    description: Deal management
  - name: Event Subscriptions
  - name: Event Types
  - name: Folders
    description: Content folders
  - name: Integrations
    description: Company integration settings
  - name: Lead Attributions
    description: Attribution records on a lead
  - name: Lead Contacts
    description: Partner contacts on a lead
  - name: Lead Custom Field Values
    description: Custom field values on a lead
  - name: Lead Distributor
    description: Distributors for a lead
  - name: Lead Notes
    description: Notes on a lead
  - name: Lead Products
    description: Products attached to a lead
  - name: Lead Quotes
    description: >-
      Quotes on a lead — generated from pricing calculators with line items and
      totals
  - name: Lead Tags
    description: Tags on a lead
  - name: Lead Tasks
    description: Tasks on a lead
  - name: Lead Users
    description: Assigned users on a lead
  - name: Leads
    description: Lead management
  - name: Marketing Templates
    description: Marketing email templates
  - name: Partner Contacts
    description: Contacts on a partner
  - name: Partner Custom Field Values
    description: Custom field values on a partner
  - name: Partner Domains
    description: Domains on a partner
  - name: Partner Notes
    description: Notes on a partner
  - name: Partner Resellers
    description: Reseller assignments on a distributor
  - name: Partner Stages
    description: Partner pipeline stages
  - name: Partner Tags
    description: Tags on a partner
  - name: Partner Users
    description: Assigned users on a partner
  - name: Partners
    description: Core partner CRUD
  - name: Pricing Calculator Fields
    description: Input fields on a pricing calculator
  - name: Pricing Calculator Formulas
    description: Discount/tax/surcharge formulas on a pricing calculator
  - name: Pricing Calculator Products
    description: Products attached to a pricing calculator
  - name: Pricing Calculators
    description: Pricing calculator configurations
  - name: Products
    description: Product catalog
  - name: Proposals
    description: >-
      Durable action proposals: an AI or API caller proposes a mutation, a
      person decides and runs it
  - name: Resource Blocks
    description: Content blocks within a resource
  - name: Resource Categories
    description: Categories on a resource
  - name: Resource Folders
    description: Folders on a resource
  - name: Resource Tags
    description: Tags on a resource
  - name: Resource Translations
  - name: Resources
    description: Learning resources
  - name: Room Blocks
    description: Content blocks within a room
  - name: Room Categories
    description: Category-based room access control
  - name: Room Partnerships
    description: Direct partnership room access
  - name: Room Secure Files
    description: >-
      Private files in a secure_files room block: folders, multipart uploads,
      signed download links and download history
  - name: Room Stages
    description: Stage-based room access control
  - name: Room Tags
    description: Tag-based room access control
  - name: Room Tiers
    description: Tier-based room access control
  - name: Rooms
    description: Partner portal rooms
  - name: Tags
    description: Tag definitions
  - name: Task Users
    description: Assigned users on a task
  - name: Tasks
    description: Task management
  - name: Terminology
    description: Display names for leads and deals
  - name: Tiers
    description: Partner tiers
  - name: Users
    description: Company team members
  - name: Webhook Events
    description: Outbound webhook payloads sent to your configured URLs when events occur
paths:
  /certifications/{uuid}/enrollments/result:
    post:
      tags:
        - Certification Enrollments
      summary: Record an externally-achieved exam result on a learner's enrolment
      operationId: recordCertificationResult
      parameters:
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: uuid
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                learner_email:
                  description: >-
                    Email of a partner contact in one of your company's
                    partnerships — resolves to the learner's user. Exactly one
                    of learner_email / user_uuid is required.
                  type: string
                  minLength: 1
                  maxLength: 320
                user_uuid:
                  description: >-
                    UUID of a user who is a partner contact in one of your
                    company's partnerships. Exactly one of learner_email /
                    user_uuid is required.
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                partnership_uuid:
                  description: >-
                    UUID of a partnership in your company — disambiguates when
                    the learner is a contact in more than one partnership
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                score:
                  description: Exam score (0-100)
                  type: integer
                  minimum: 0
                  maximum: 100
                passed:
                  type: boolean
                  description: Whether the learner passed the external exam
                achieved_date:
                  type: string
                  format: date
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                  description: >-
                    Calendar date, YYYY-MM-DD (stored as that day at 12:00 UTC).
                    The date the result was achieved; must not be in the future
                expiry_date:
                  description: >-
                    Calendar date, YYYY-MM-DD (stored as that day at 12:00 UTC).
                    When the certificate expires; omit to derive from the
                    certification's validity schedule, null for no expiry
                  anyOf:
                    - type: string
                      format: date
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                    - type: 'null'
              required:
                - passed
                - achieved_date
              additionalProperties: false
              description: >-
                Record an exam result achieved outside the platform on a
                learner's enrolment. Completes (or fails) the learner's current
                enrolment period with the supplied dates and marks it as an
                external result; later learner activity never overwrites it.
        description: >-
          Record an exam result achieved outside the platform on a learner's
          enrolment. Completes (or fails) the learner's current enrolment period
          with the supplied dates and marks it as an external result; later
          learner activity never overwrites it.
      responses:
        '200':
          description: A user's enrollment and progress in a certification.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                  user_uuid:
                    type: string
                  user_email:
                    type: string
                  status:
                    type: string
                    enum:
                      - enrolled
                      - in_progress
                      - completed
                      - failed
                    description: enrolled → in_progress → completed or failed
                  progress_percentage:
                    type: number
                    description: Completion progress (0-100)
                  enrolled_at:
                    type: string
                  started_at:
                    anyOf:
                      - type: string
                      - type: 'null'
                  completed_at:
                    anyOf:
                      - type: string
                      - type: 'null'
                  assessment_best_score:
                    description: Highest assessment score (0-100), or null if not attempted
                    anyOf:
                      - type: number
                      - type: 'null'
                  assessment_passed:
                    description: Whether the user passed the assessment
                    anyOf:
                      - type: boolean
                      - type: 'null'
                  result_source:
                    type: string
                    enum:
                      - platform
                      - external
                      - imported
                    description: >-
                      Where the result came from: 'platform' (learner activity),
                      'external' (recorded by an admin), or 'imported'
                      (bulk-imported issued certificate)
                  expires_at:
                    description: >-
                      When the certificate on this enrolment's current period
                      expires, or null when the certification has no validity
                      schedule
                    anyOf:
                      - type: string
                      - type: 'null'
                  expired:
                    type: boolean
                    description: >-
                      Whether the certificate on this enrolment has passed its
                      expiry date
                required:
                  - uuid
                  - user_uuid
                  - user_email
                  - status
                  - progress_percentage
                  - enrolled_at
                  - started_at
                  - completed_at
                  - assessment_best_score
                  - assessment_passed
                  - result_source
                  - expires_at
                  - expired
                additionalProperties: false
                description: A user's enrollment and progress in a certification.
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.