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

# Invite people to a workspace

> Adds each address at the role given, `viewer` unless one is named, and emails them. Addresses already in the workspace come back in `existing` by name. Nobody is invited as `owner`: the Owner hands ownership over with `POST /api/workspaces/:id/owner`.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json post /api/members/workspace/{workspace}/invite
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/members/workspace/{workspace}/invite:
    post:
      tags:
        - Workspaces
      summary: Invite people to a workspace
      description: >-
        Adds each address at the role given, `viewer` unless one is named, and
        emails them. Addresses already in the workspace come back in `existing`
        by name. Nobody is invited as `owner`: the Owner hands ownership over
        with `POST /api/workspaces/:id/owner`.
      operationId: post/api/members/workspace/:workspace/invite
      parameters:
        - name: workspace
          in: path
          required: true
          description: The workspace's id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: string
                  description: Addresses separated by commas, spaces or new lines.
                role:
                  type: string
                  enum:
                    - viewer
                    - editor
                    - admin
              required:
                - emails
            example:
              emails: dana@example.com
              role: editor
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: array
                    items:
                      type: string
                  existing:
                    type: array
                    items:
                      type: string
                  failed:
                    type: array
                    items:
                      type: string
                required:
                  - created
                  - existing
                  - failed
        '400':
          description: '`invalid_request`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.