Kyoraq
    Use CasesPricingEventiclesKnowledge Base
    Log inSign Up

    Getting Started

    Welcome to KyoraqFor Admins: Signup & SetupJoining as Instructor/LearnerTour: Admin DashboardTour: Instructor DashboardTour: Learner Dashboard

    Organization (Admins)

    Setting Up Your OrgInviting InstructorsOnboarding ParticipantsRoles & PermissionsBilling & LimitsOrg Analytics

    Events Management

    Creating an EventEvent Tracks ExplainedTickets & CapacityEvent Analytics

    Courses & Content

    Creating First CourseModules & LessonsUploading Content (SCORM)Assignments & QuizzesAdmin: Reassigning Courses

    Registration

    Registration MethodsUsing Form BuilderManual & Bulk ImportManaging Status

    Learner Experience

    Navigating DashboardInside the ClassroomTaking QuizzesCertificates & Badges

    Kyoraq AI

    AI Overview & PrivacyFor AdminsFor InstructorsFor LearnersAgentic Workflows

    Messaging

    Messaging OverviewAdmin ToolsInstructor ToolsParticipant Chat

    Payments

    Monetization OverviewManual Payment WorkflowExternal Checkout

    Integrations

    Video ConferencingPayment GatewaysAPI & Headless

    Security & Data

    Data OwnershipRetention PoliciesAccount SecurityGDPR Compliance

    Developers

    API OverviewRegistration APIEmbed Integration
    DocsDevelopersParticipant Registration Endpoint

    Participant Registration Endpoint

    Last updated: 2025-05-20

    Register Participant API

    Use this endpoint to programmatically register a user for an event. This is ideal for syncing users after they purchase a ticket on your own website (WooCommerce, Shopify, etc.).

    Endpoint

    POST /registrations

    Headers

    • Content-Type: application/json
    • x-api-key: YOUR_API_SECRET

    Getting Your IDs

    To find the specific eventId and trackIds for your payload:

    1. Go to Registration Forms.
    2. Click Publish on the relevant form.
    3. Switch to the API Integration tab to copy the IDs.

    Request Body

    {
      "eventId": "65a1b2c3d4e5f6g7h8i9j0k1",
      "email": "learner@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "paymentStatus": "paid",
      "trackIds": [
        "65x9y8z7..."  // Optional: Specific track IDs to enroll in
      ],
      "profileFields": {
        "phoneNumber": "+1234567890",
        "jobTitle": "Senior Developer",
        "bio": "Excited to learn!"
      }
    }
    

    Behavior

    • New Users: An account is created, and they receive a "Setup Password" email.
    • Existing Users: They are simply enrolled in the new event/tracks without overwriting their existing profile data.
    • Free Events: The paymentStatus is automatically set to free, ignoring the payload.

    Response

    Returns 200 OK on success.

    {
      "success": true,
      "data": {
        "userId": "...",
        "isNewUser": true
      }
    }
    
    Back to Overview