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

# Add a custom domain



## OpenAPI

````yaml /api-reference/openapi.json post /enterprise/domains
openapi: 3.0.0
info:
  title: EngageFabric API
  description: >-
    EngageFabric is a multi-tenant SaaS gamification framework. This API
    provides endpoints for managing players, tracking events, quests,
    adventures, leaderboards, lobbies, and real-time features.
  version: 1.0.0
  contact:
    name: EngageFabric Support
    url: https://engagefabric.com
    email: support@engagefabric.com
  license:
    name: Proprietary
    url: https://engagefabric.com/terms
servers:
  - url: https://api.engagefabric.com
    description: Production
  - url: http://localhost:3000
    description: Development
security: []
tags:
  - name: auth
    description: Authentication endpoints
  - name: tenants
    description: Tenant management
  - name: projects
    description: Project management
  - name: players
    description: Player management and game state
  - name: events
    description: Event ingestion and tracking
  - name: quests
    description: Quest management and progress
  - name: adventures
    description: Adventure/season management
  - name: leaderboards
    description: Leaderboard rankings
  - name: lobbies
    description: Multiplayer lobby management
  - name: chat
    description: Real-time chat
  - name: rules
    description: Rules engine configuration
paths:
  /enterprise/domains:
    post:
      tags:
        - enterprise
      summary: Add a custom domain
      operationId: EnterpriseController_addDomain
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomDomainDto'
      responses:
        '201':
          description: Domain added, returns DNS records to configure
        '403':
          description: Feature not available on current plan
        '409':
          description: Domain already in use
      security:
        - JWT: []
components:
  schemas:
    CreateCustomDomainDto:
      type: object
      properties:
        domain:
          type: string
          description: The custom domain
          example: api.customer.com
        domainType:
          type: string
          description: Type of domain (API, ADMIN, or BOTH)
          enum:
            - API
            - ADMIN
            - WIDGET
          default: API
      required:
        - domain
  securitySchemes:
    JWT:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT token for admin console authentication

````