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

# Convidar membro

> Convida um e-mail. Endereço que já tem convite pendente NÃO é erro: rotaciona o token na mesma linha (o link antigo morre) e devolve `200` em vez de `201`.

**Exige OAuth.** Chave clássica (`x-api-key`) é recusada: numa requisição `x-api-key` não há usuário por trás, e permitir escrita na lista de membros faria de qualquer chave do workspace um caminho de takeover da conta.



## OpenAPI

````yaml openapi.pt.json POST /v1/workspace/members
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/workspace/members:
    post:
      tags:
        - Workspace
      summary: Convidar membro
      description: >-
        Convida um e-mail. Endereço que já tem convite pendente NÃO é erro:
        rotaciona o token na mesma linha (o link antigo morre) e devolve `200`
        em vez de `201`.


        **Exige OAuth.** Chave clássica (`x-api-key`) é recusada: numa
        requisição `x-api-key` não há usuário por trás, e permitir escrita na
        lista de membros faria de qualquer chave do workspace um caminho de
        takeover da conta.
      operationId: post_workspace-members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: Normalizado para minúsculas.
                  example: alguem@acme.com
                role:
                  type: string
                  enum:
                    - ADMIN
                    - AGENT
                    - ANALYST
                  description: >-
                    `OWNER` NUNCA é atribuível — virar dono é transferência de
                    posse.
                  example: AGENT
                allowedNumberIds:
                  type: array
                  items:
                    type: string
                  description: >-
                    Restringe AGENT/ANALYST a números específicos. Ignorado para
                    ADMIN, que é workspace-wide.
                sendEmail:
                  type: boolean
                  description: >-
                    Default `true`. Com `false` nenhum e-mail sai e a resposta
                    traz `inviteUrl` — a ÚNICA vez que o link aparece.
                  example: true
              required:
                - email
                - role
      responses:
        '200':
          description: Convite pendente rotacionado
        '201':
          description: Convite criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  member:
                    type: object
                    properties:
                      id:
                        type: string
                        example: mb_1a2b
                      email:
                        type: string
                        example: alguem@acme.com
                      name:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        enum:
                          - OWNER
                          - ADMIN
                          - AGENT
                          - ANALYST
                      status:
                        type: string
                        enum:
                          - PENDING
                          - ACTIVE
                      allowedNumberIds:
                        type: array
                        items:
                          type: string
                      invitedAt:
                        type: string
                        format: date-time
                      joinedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      inviteExpiresAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      inviteExpired:
                        type: boolean
                        description: >-
                          `true` quando o convite venceu: a linha existe mas não
                          ocupa assento.
                  inviteUrl:
                    type:
                      - string
                      - 'null'
                    description: 'Presente apenas com `sendEmail: false`.'
        '400':
          description: Payload inválido (`INVALID_EMAIL`, papel ausente).
        '403':
          description: Papel insuficiente, credencial errada ou convites desabilitados.
        '409':
          description: >-
            Conflito de estado: `ALREADY_MEMBER`, `SEAT_LIMIT_REACHED`,
            `OWNER_INVITE_FORBIDDEN`, `OWNER_IMMUTABLE`.
        '429':
          description: Limitado por workspace, por destinatário e por IP.
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````