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

# Invite a user to join a team

> Send an invitation email to a user to join a team



## OpenAPI

````yaml post /auth/invite
openapi: 3.0.3
info:
  title: Xem API
  version: '1.0'
  description: Comprehensive API server for Xem email marketing platform
  contact: {}
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.xem.email/api/v1
    description: Production server
  - url: http://localhost:8080/api/v1
    description: Development server
security: []
tags:
  - name: Authentication
    description: User authentication and authorization endpoints
  - name: Teams
    description: Team management and collaboration features
  - name: Campaigns
    description: Email campaign creation, management, and tracking
  - name: Analytics
    description: Campaign analytics, audience insights, and performance metrics
  - name: Contacts
    description: Contact management and mailing list operations
  - name: Templates
    description: Email template management and customization
  - name: Automations
    description: Email automation workflows and triggers
  - name: SMTP
    description: SMTP configuration and email delivery settings
  - name: IMAP
    description: IMAP configuration for email inbox management
  - name: Webhooks
    description: Webhook management for real-time event notifications
  - name: Files
    description: File upload and management for attachments and media
  - name: Domains
    description: Domain management for email authentication
  - name: API Keys
    description: API key management for programmatic access
paths:
  /auth/invite:
    post:
      tags:
        - auth
      summary: Invite a user to join a team
      description: Send an invitation email to a user to join a team
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/internal_handlers.InviteUserRequest'
      responses:
        '201':
          description: Invitation sent successfully
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      security: []
components:
  schemas:
    internal_handlers.InviteUserRequest:
      description: Send an invitation email to a user to join a team
      type: object
      required:
        - email
        - name
        - role
      properties:
        email:
          type: string
        name:
          type: string
          minLength: 2
        role:
          type: string
          default: MEMBER
          enum:
            - MEMBER
            - ADMIN
            - SUPER_ADMIN

````