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

# Install a published module

> A partner admin installs a published module version for the authenticated organization. A private module can be installed only by its owning organization. Use an admin session; an `org_` service key cannot install modules.



## OpenAPI

````yaml https://api.develop.fourdos.dev/openapi/partner.json post /v1/modules/{moduleId}/install
openapi: 3.1.0
info:
  title: 4D OS Partner API
  version: 0.1.0
  description: >-
    REST API for 4D OS partners. Authenticate with your organization API key:
    `Authorization: Bearer <key>`.


    Requests and responses are JSON with `snake_case` field names. Errors share
    one envelope: `{ "error": { "code", "status", "message", "details"? } }`.


    Mutating endpoints that declare it accept an `Idempotency-Key` header so
    retries are safe.


    Bulk-migrating members? See the [Migrating to 4D
    guide](https://docs.fourdos.dev/walkthroughs/migrate-existing-members) for
    the canonical import schema, a worked example, and the `/v1/imports`
    sequence.
servers:
  - url: https://api.develop.fourdos.dev
security:
  - partnerApiKey: []
tags:
  - name: Users
    description: Create, read, and manage users and their org membership
  - name: Imports
    description: Bulk member import jobs (staging → validate → commit)
  - name: API keys
    description: Issue, list, and revoke server-side organization API keys
  - name: Modules
    description: >-
      Publish private modules, install visible modules, and manage their
      credentials
  - name: Ingest
    description: Receive signed native events from an installed module
  - name: Engagement
    description: Browser event tracking (publishable keys) and tracking-key management
paths:
  /v1/modules/{moduleId}/install:
    post:
      tags:
        - Modules
      summary: Install a published module
      description: >-
        A partner admin installs a published module version for the
        authenticated organization. A private module can be installed only by
        its owning organization. Use an admin session; an `org_` service key
        cannot install modules.
      operationId: installModule
      parameters:
        - name: moduleId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallModuleBody'
      responses:
        '201':
          description: Module installed or existing installation returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleInstallationResponse'
        '401':
          description: Authentication is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: A partner admin or platform admin session is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Module or version not found or not visible to this organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Only a published module version can be installed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - adminSession: []
components:
  schemas:
    InstallModuleBody:
      type: object
      properties:
        version_id:
          type: string
          minLength: 1
        config:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
      required:
        - version_id
    ModuleInstallationResponse:
      type: object
      properties:
        id:
          type: string
        module_id:
          type: string
        organization_id:
          type: string
        version_id:
          type: string
        status:
          type: string
          enum:
            - enabled
            - disabled
            - error
        config:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        installed_by:
          anyOf:
            - type: string
            - type: 'null'
        installed_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - module_id
        - organization_id
        - version_id
        - status
        - config
        - installed_by
        - installed_at
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            status:
              type: integer
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - status
            - message
      required:
        - error
  securitySchemes:
    partnerApiKey:
      type: http
      scheme: bearer
      description: >-
        Organization API key (`org_...`) sent as `Authorization: Bearer <key>`.
        Keys are scoped to one organization; every request operates within that
        tenant.
    adminSession:
      type: http
      scheme: bearer
      description: >-
        Partner admin session token sent as `Authorization: Bearer <token>`.
        Obtained by signing in (console or the email OTP endpoints) and
        completing the second factor; see the Authentication page.

````