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

> Invite one or more users to become members of a project, optionally assigning them to groups and setting owner status.



## OpenAPI

````yaml /openapi/brms.json post /api/projects/{projectId}/members
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/projects/{projectId}/members:
    post:
      tags:
        - Member
      summary: Invite members
      description: >-
        Invite one or more users to become members of a project, optionally
        assigning them to groups and setting owner status.
      operationId: inviteMembers
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: projectId
          required: true
          description: Unique identifier of the project
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: List of user IDs to invite to the project
                groupIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: List of group IDs to assign to the new members
                owner:
                  type: boolean
                  default: false
                  description: Whether the invited members should be project owners
              required:
                - userIds
        required: true
      responses:
        '200':
          description: List of newly created membership records
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      description: Unique identifier of the member
                    owner:
                      type: boolean
                      description: Whether the member is an owner of the project
                    userId:
                      type: string
                      format: uuid
                      description: User ID of the member
                    projectId:
                      type: string
                      format: uuid
                      description: Project ID the member belongs to
                    user:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Unique identifier of the user
                        email:
                          type: string
                          format: email
                          description: Email address of the user
                        firstName:
                          type: string
                          nullable: true
                          description: First name of the user
                        lastName:
                          type: string
                          nullable: true
                          description: Last name of the user
                        type:
                          type: string
                          description: Type of user (e.g., OWNER, ADMIN, MEMBER)
                        status:
                          type: string
                          description: Status of the user (e.g., ACTIVE, INACTIVE)
                        organisationId:
                          type: string
                          format: uuid
                          description: Organisation the user belongs to
                        isService:
                          type: boolean
                          description: Whether this is a service account
                        createdAt:
                          type: string
                          description: Timestamp when the user was created
                        updatedAt:
                          type: string
                          description: Timestamp when the user was last updated
                      required:
                        - id
                        - email
                        - firstName
                        - lastName
                        - type
                        - status
                        - organisationId
                        - createdAt
                        - updatedAt
                      description: User details of the member
                    groups:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: Unique identifier of the group
                          name:
                            type: string
                            description: Name of the group
                          description:
                            type: string
                            nullable: true
                            description: Description of the group
                          projectId:
                            type: string
                            format: uuid
                            description: Project the group belongs to
                          permissions:
                            type: array
                            nullable: true
                            items:
                              type: string
                            description: List of permissions assigned to the group
                          roleId:
                            type: string
                            nullable: true
                            format: uuid
                            description: Role ID associated with the group
                        required:
                          - id
                          - name
                          - projectId
                          - permissions
                      description: Groups the member belongs to
                    createdAt:
                      type: string
                      description: Timestamp when the member was created
                    updatedAt:
                      type: string
                      description: Timestamp when the member was last updated
                  required:
                    - id
                    - createdAt
                    - updatedAt
                description: List of newly created membership records
      security:
        - personalAccessToken: []
        - internalAuth: []
components:
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      description: Personal access token is obtained through your profile
    internalAuth:
      type: http
      scheme: internal
      description: Cannot be used directly

````