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

# Invite users with roles and access



## OpenAPI

````yaml /openapi/customer-api.json post /users/invite/bulk-detailed
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /users/invite/bulk-detailed:
    post:
      tags:
        - Users
      summary: >-
        Invite many fully-specified users at once (per-user name, role, and
        project access). Used by the v2 -> v3 migration to provision users in
        one round-trip while preserving each source user’s name and scope.
      operationId: UsersController_inviteUsersBulkDetailed
      parameters:
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkInviteDetailedDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkInviteResultDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    BulkInviteDetailedDto:
      properties:
        customer:
          type: string
        suppress_notification:
          default: false
          type: boolean
        users:
          items:
            $ref: '#/components/schemas/BulkInviteUserEntryDto'
          maxItems: 200
          type: array
      required:
        - customer
        - users
      type: object
    BulkInviteResultDto:
      properties:
        failed:
          items:
            $ref: '#/components/schemas/BulkInviteFailureDto'
          type: array
        invited:
          items:
            type: string
          type: array
      required:
        - invited
        - failed
      type: object
    BulkInviteUserEntryDto:
      properties:
        all_projects:
          default: true
          type: boolean
        email:
          type: string
        family_name:
          type: string
        given_name:
          type: string
        project_ids:
          items:
            type: string
          type: array
        role:
          allOf:
            - $ref: '#/components/schemas/Role'
          default: editor
      required:
        - email
      type: object
    BulkInviteFailureDto:
      properties:
        email:
          type: string
        message:
          type: string
      required:
        - email
        - message
      type: object
    Role:
      enum:
        - admin
        - editor
        - read_only
        - external
      type: string
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````