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

# Atualizar status do canal

> Reconsulta o provedor para cada canal ou servidor já vinculado e grava a situação encontrada: bot removido, permissão faltando, ou tudo certo. Use antes de uma campanha, ou quando um comprador reclamar que não recebeu o convite — é assim que se descobre que alguém tirou o bot do grupo sem esperar a próxima venda falhar.



## OpenAPI

````yaml /openapi.yaml post /v1/integrations/{provider}/channels/refresh
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/integrations/{provider}/channels/refresh:
    post:
      tags:
        - Plataforma
      summary: Atualizar status do canal
      description: >-
        Reconsulta o provedor para cada canal ou servidor já vinculado e grava a
        situação encontrada: bot removido, permissão faltando, ou tudo certo.
        Use antes de uma campanha, ou quando um comprador reclamar que não
        recebeu o convite — é assim que se descobre que alguém tirou o bot do
        grupo sem esperar a próxima venda falhar.
      operationId: refreshCommunityChannelStatus
      parameters:
        - schema:
            type: string
            enum:
              - telegram
              - discord
          in: path
          name: provider
          required: true
          description: 'Provedor da comunidade: `telegram` ou `discord`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
              additionalProperties: false
            example: {}
      responses:
        '200':
          description: Canais da empresa com a situação recém-conferida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            Identificador da conexão nesta plataforma, usado
                            para atualizar, pausar ou desconectar.
                        provider:
                          type: string
                          enum:
                            - memberkit
                            - cademi
                            - spedy
                            - notazz
                            - reportana
                            - utmify
                            - metrito
                            - voxuy
                            - astrofy
                            - telegram
                            - discord
                          description: >-
                            Aplicativo externo: `memberkit`, `cademi`, `spedy`,
                            `notazz`, `reportana`, `utmify`, `metrito`, `voxuy`,
                            `astrofy`, `telegram` ou `discord`.
                        name:
                          type: string
                          nullable: true
                          description: >-
                            Apelido dado à conexão, ou o nome do canal/servidor
                            vinculado.
                        active:
                          type: boolean
                          description: >-
                            `false` quando a conexão está pausada, removida ou
                            sem permissão no provedor.
                        status:
                          type: string
                          nullable: true
                          description: >-
                            Situação relatada pelo provedor (`active`,
                            `bot_removed`, `missing_permissions`). `null` onde
                            não se aplica.
                        externalId:
                          type: string
                          nullable: true
                          description: >-
                            Identificador no provedor: `chatId` do Telegram, id
                            do servidor Discord, subdomínio da Cademi.
                        hasCredentials:
                          type: boolean
                          description: >-
                            `true` quando há credencial do provedor guardada. O
                            segredo em si nunca é devolvido.
                        productIds:
                          type: array
                          items:
                            type: string
                          description: >-
                            Produtos já vinculados a esta conexão, quando o
                            provedor aceita vínculo.
                        createdAt:
                          type: string
                          format: date-time
                          description: Momento em que a conexão foi criada.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Momento da última alteração.
                      required:
                        - id
                        - provider
                        - name
                        - active
                        - status
                        - externalId
                        - hasCredentials
                        - productIds
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Página devolvida.
                      pageSize:
                        type: integer
                        description: Itens por página pedidos.
                      total:
                        type: integer
                        description: Total de itens que satisfazem o filtro.
                      totalPages:
                        type: integer
                        description: Total de páginas disponíveis.
                    required:
                      - page
                      - pageSize
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - pagination
                additionalProperties: false
                description: Canais da empresa com a situação recém-conferida.
              example:
                success: true
                data:
                  - id: clx9z8y7x0001qz0a2f5g6h7j
                    provider: telegram
                    name: Comunidade Confeitaria Artesanal
                    active: true
                    status: active
                    externalId: '-1002345678901'
                    hasCredentials: false
                    productIds:
                      - clx8a2h4k0001qz0a1b2c3d4e
                    createdAt: '2026-08-19T13:40:00.000Z'
                    updatedAt: '2026-09-10T08:05:00.000Z'
                pagination:
                  page: 1
                  pageSize: 10
                  total: 1
                  totalPages: 1
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````