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

# Abrir uma conversa com o suporte

> Abre um chamado com a primeira mensagem.

Toda conversa ganha um número (`#1024`), que é como ela é citada por e-mail e ao telefone.


## OpenAPI

````yaml POST /v1/clubs/{clubId}/support/conversations
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.useweve.com
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
  - name: terms
  - name: mcp
  - name: gamification
  - name: support
  - name: help
paths:
  /v1/clubs/{clubId}/support/conversations:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    post:
      tags:
        - support
      summary: Abre uma conversa com o suporte
      description: |
        A conversa nasce com a primeira mensagem, que é obrigatória: uma
        conversa sem nada escrito é um chamado que ninguém sabe responder. O
        assunto é opcional — quem escreve pelo chat raramente dá título ao que
        está perguntando, e a equipe lê a mensagem de qualquer forma.

        Toda conversa ganha um número (`#1024`), que é como ela é citada por
        e-mail e ao telefone.
      operationId: createSupportConversation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewSupportConversation'
      responses:
        '201':
          description: A conversa aberta, com a primeira mensagem
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportThread'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
  schemas:
    NewSupportConversation:
      type: object
      required:
        - body
      properties:
        subject:
          type: string
          maxLength: 160
        body:
          type: string
          minLength: 1
          maxLength: 10000
    SupportThread:
      type: object
      required:
        - conversation
        - messages
      properties:
        conversation:
          $ref: '#/components/schemas/SupportConversation'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/SupportMessage'
    SupportConversation:
      type: object
      required:
        - id
        - number
        - subject
        - status
        - opened_by
        - unread
        - created_at
        - last_message_at
        - last_message_preview
        - last_message_author
      properties:
        id:
          type: string
          format: uuid
        number:
          type: integer
          format: int64
          description: O número do chamado (`#1024`), único na weve inteira.
        subject:
          type: string
          description: Vazio quando quem abriu não deu assunto.
        status:
          $ref: '#/components/schemas/SupportConversationStatus'
        opened_by:
          description: Quem abriu. Nulo quando a conta dessa pessoa foi apagada.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/SupportPerson'
        unread:
          type: boolean
          description: Há resposta da weve que esta pessoa ainda não leu.
        created_at:
          type: string
          format: date-time
        last_message_at:
          type: string
          format: date-time
        last_message_preview:
          type: string
          description: O começo da última mensagem visível ao club, numa linha só.
        last_message_author:
          $ref: '#/components/schemas/SupportAuthorKind'
    SupportMessage:
      type: object
      required:
        - id
        - author_kind
        - author_name
        - mine
        - body
        - created_at
      properties:
        id:
          type: string
          format: uuid
        mine:
          type: boolean
          description: |
            Foi quem está na sessão que escreveu. É o que a tela usa para dizer
            "Você" — o nome não serve, porque dois do time podem ter o mesmo.
        author_kind:
          $ref: '#/components/schemas/SupportAuthorKind'
        author_name:
          type: string
          description: |
            Quem escreveu: o nome da pessoa do club, ou o de quem atendeu na
            weve. Vazio numa mensagem `system`, ou quando a conta foi apagada.
        body:
          type: string
          description: Texto puro; a quebra de linha é da pessoa.
        created_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    SupportConversationStatus:
      type: string
      description: |
        `open` é a vez da weve responder; `pending`, a vez do club (a equipe
        respondeu e espera); `resolved`, encerrada — escrever nela a reabre.
      enum:
        - open
        - pending
        - resolved
    SupportPerson:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    SupportAuthorKind:
      type: string
      description: |
        `club` é alguém do time do club; `weve`, a equipe da weve; `system`, o
        próprio produto narrando ("conversa encerrada").
      enum:
        - club
        - weve
        - system
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Ver uma conversa com o suporte](/api-reference/support/get.md)
- [Listar as conversas com o suporte](/api-reference/support/list.md)
- [Responder numa conversa com o suporte](/api-reference/support/reply.md)
- [Abrir uma conversa](/api-reference/comments/threads-get.md)
- [Marcar a conversa como lida](/api-reference/support/read.md)