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

# Invite team members

> Invites people to your team by email; each invitation lasts 7 days.

<Accordion title="Details">
  * Send one address as email, or up to 500 as invitations or as a CSV file's text in csv.

  * An address already on the team, in another team or repeated in the request is refused on its own row. One already invited returns its pending invitation.

  * Only an owner can invite an owner.

  * With an Idempotency-Key, repeating the same request returns the first answer.

  * **Callers:** an API key, an MCP OAuth token or a Dashboard session.

  * **Permission:** `team:manage`; an API key also needs `team:manage`.

  * **Effect:** Creates or changes something.

  * **Errors:** [`invalid_email`](/errors#invalid_email), [`already_member`](/errors#already_member), [`already_invited`](/errors#already_invited), [`in_another_team`](/errors#in_another_team), [`role_not_allowed`](/errors#role_not_allowed), [`team_unavailable`](/errors#team_unavailable), [`idempotency_conflict`](/errors#idempotency_conflict), [`acceptance_unknown`](/errors#acceptance_unknown), and the [errors any request can get](/errors).
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json post /v1/team/invitations
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Saved logins
  - name: two_factor
    x-group: 2FA
  - name: login_access
    x-group: Login access
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: files
    x-group: Files
  - name: team
    x-group: Team
paths:
  /v1/team/invitations:
    post:
      tags:
        - team
      summary: Invite team members
      description: Invites people to your team by email; each invitation lasts 7 days.
      operationId: team.invite
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Repeat a request safely: the same key and body answer the first
            request's job again with Idempotent-Replayed: true; the same key
            with a different body answers idempotency_conflict.
          schema:
            type: string
            description: 1 to 200 letters, digits, _ or -, such as a UUID
            pattern: ^[A-Za-z0-9_-]{1,200}$
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              required: []
              properties:
                email:
                  type: string
                  description: One address to invite; answers its Invitation
                  maxLength: 320
                role:
                  type: string
                  enum:
                    - owner
                    - admin
                    - member
                  description: 'With email: its role (default member)'
                invitations:
                  type: array
                  items:
                    type: object
                    required:
                      - email
                    properties:
                      email:
                        type: string
                        description: a string at most 320 character(s) long
                        maxLength: 320
                      role:
                        type: string
                        enum:
                          - owner
                          - admin
                          - member
                        description: 'Default: member'
                    additionalProperties: false
                  description: >-
                    Up to 500 addresses, each with an optional role; answers
                    each row's result
                csv:
                  type: string
                  description: >-
                    A CSV file's text: an email column and an optional role
                    column, with or without a header row, up to 500 rows;
                    answers each row's result
              additionalProperties: false
      responses:
        '200':
          description: 'With invitations or csv: each row''s invitation or error, by index'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationResults'
        '201':
          description: 'With email: the invitation'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: invalid_request, invalid_email
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: role_not_allowed, forbidden, team_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            already_member, already_invited, in_another_team,
            idempotency_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: request_too_large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: acceptance_unknown, temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    InvitationResults:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          items:
            type: object
            required:
              - index
              - email
            properties:
              index:
                $ref: '#/components/schemas/Int'
              email:
                type: string
              invitation:
                $ref: '#/components/schemas/Invitation'
              error:
                type: object
                required:
                  - code
                  - message
                  - retryable
                  - docs_url
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  docs_url:
                    type: string
                additionalProperties: false
            additionalProperties: false
      additionalProperties: false
    Invitation:
      type: object
      required:
        - id
        - email
        - role
        - status
        - invited_by
        - created_at
        - expires_at
      properties:
        id:
          type: string
          description: The invitation's ID (invitation_…)
        email:
          type: string
        role:
          anyOf:
            - type: string
              enum:
                - owner
                - admin
                - member
            - type: 'null'
          description: The role the invitee gets; null when it isn't one Pomerado knows
        status:
          type: string
          enum:
            - pending
            - expired
        invited_by:
          anyOf:
            - type: string
            - type: 'null'
          description: The inviter's user ID, when recorded
        created_at:
          $ref: '#/components/schemas/Date'
        expires_at:
          $ref: '#/components/schemas/Date'
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    Int:
      type: integer
      description: an integer
    Date:
      type: string
      description: a string to be decoded into a Date
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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