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

# Invite users

> Sends invitation emails to the specified email addresses to join the organisation.



## OpenAPI

````yaml /openapi/brms.json post /api/users
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/users:
    post:
      tags:
        - User
      summary: Invite users
      description: >-
        Sends invitation emails to the specified email addresses to join the
        organisation.
      operationId: inviteUsers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: string
                    format: email
                    description: Email address to invite
                  description: List of email addresses to invite (max 10)
              required:
                - emails
        required: true
      responses:
        '200':
          description: List of created invitations
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      description: Unique identifier of the invitation
                    email:
                      type: string
                      format: email
                      description: Email address the invitation was sent to
                    status:
                      type: string
                      enum:
                        - pending
                        - accepted
                      description: Current status of the invitation
                    userId:
                      type: string
                      format: uuid
                      description: ID of the user associated with this invitation
                    createdAt:
                      type: string
                      description: Timestamp when the invitation was created
                    expiresAt:
                      type: string
                      nullable: true
                      description: Timestamp when the invitation expires
                  required:
                    - id
                    - email
                    - status
                    - userId
                    - createdAt
                description: List of created invitations
      security:
        - internalAuth: []
components:
  securitySchemes:
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````