> ## 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.

# Create a private module draft

> A partner admin creates a draft module owned by the admin's organization. An `org_` bearer key is a service identity and cannot author module changes; use an admin session for this operation.



## OpenAPI

````yaml https://api.develop.fourdos.dev/openapi/partner.json post /v1/modules
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:
    post:
      tags:
        - Modules
      summary: Create a private module draft
      description: >-
        A partner admin creates a draft module owned by the admin's
        organization. An `org_` bearer key is a service identity and cannot
        author module changes; use an admin session for this operation.
      operationId: createModule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModuleBody'
      responses:
        '201':
          description: Private module draft created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleResponse'
        '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'
        '409':
          description: >-
            A platform or vendor module, or one this organization already owns,
            uses this slug. A slug another organization uses privately is free
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - adminSession: []
components:
  schemas:
    CreateModuleBody:
      type: object
      properties:
        slug:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^[a-z0-9-]+$
        name:
          type: string
          minLength: 1
          maxLength: 128
        kind:
          type: string
          enum:
            - proprietary
            - in_house
            - third_party
        vendor:
          type: string
          maxLength: 128
      required:
        - slug
        - name
        - kind
    ModuleResponse:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        kind:
          type: string
          enum:
            - proprietary
            - in_house
            - third_party
        vendor:
          anyOf:
            - type: string
            - type: 'null'
        owner_organization_id:
          anyOf:
            - type: string
            - type: 'null'
        current_version_id:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - draft
            - published
            - deprecated
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - slug
        - name
        - kind
        - vendor
        - owner_organization_id
        - current_version_id
        - status
        - 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.

````