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

# Banir/Desbanir Usuário

> Alterna o status de banimento de um usuário. Requer autenticação JWT.

## Descrição

Alterna o status de banimento de um usuário. Se o usuário estiver ativo, será banido. Se estiver banido, será reativado. **Requer autenticação JWT**.

## Headers

<ParamField header="Authorization" type="string" required>
  Token JWT no formato: Bearer {token}
</ParamField>

## Request Body

<ParamField body="email" type="string" required>
  Email do usuário a ser banido/desbanido
</ParamField>

<ParamField body="reason" type="string">
  Motivo do banimento (opcional)
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Indica se a operação foi bem-sucedida
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="user_email" type="string">
      Email do usuário afetado
    </ResponseField>

    <ResponseField name="action" type="string">
      Ação realizada: "banned" ou "unbanned"
    </ResponseField>

    <ResponseField name="banned_at" type="string">
      Data do banimento (se aplicável)
    </ResponseField>

    <ResponseField name="reason" type="string">
      Motivo do banimento (se fornecido)
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request POST \
    --url https://backend.testeswaffle.org/referrals/ban \
    --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
    --header 'Content-Type: application/json' \
    --data '{
      "email": "usuario.suspeito@exemplo.com",
      "reason": "Múltiplas tentativas de fraude detectadas"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "user_email": "usuario.suspeito@exemplo.com",
      "action": "banned",
      "banned_at": "2024-01-15T16:45:00Z",
      "reason": "Múltiplas tentativas de fraude detectadas"
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml POST /referrals/ban
openapi: 3.1.0
info:
  title: Referrals API
  description: API para gerenciamento do programa de indicações do the news
  version: 1.0.0
servers:
  - url: https://backend.testeswaffle.org
security:
  - bearerAuth: []
paths:
  /referrals/ban:
    post:
      tags:
        - Authenticated
      summary: Banir/Desbanir Usuário
      description: Alterna o status de banimento de um usuário. Requer autenticação JWT.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
                  description: Email do usuário
                reason:
                  type: string
                  description: Motivo do banimento
      responses:
        '200':
          description: Operação realizada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      user_email:
                        type: string
                      action:
                        type: string
                      banned_at:
                        type: string
                        format: date-time
                      reason:
                        type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````