> ## 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.

# Inscrever via Referral

> Inscreve através do programa de indicações

## Descrição

Inscreve um novo indicado na newsletter através do programa de indicações. Este endpoint é público e cria um referral pendente até que o indicado confirme sua inscrição.

## Request Body

<ParamField body="referrer_id" type="string" required>
  ID do usuário que está fazendo a indicação
</ParamField>

<ParamField body="referred_email" type="string" required>
  Email da pessoa sendo indicada
</ParamField>

<ParamField body="referred_name" type="string">
  Nome da pessoa sendo indicada
</ParamField>

<ParamField body="newsletter" type="string">
  Newsletter para inscrição (padrão: thenews)
</ParamField>

<ParamField body="campaign" type="string">
  Nome da campanha de indicação para tracking
</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="referral_id" type="string">
      ID único da indicação criada
    </ResponseField>

    <ResponseField name="status" type="string">
      Status da indicação (sempre "pending" inicialmente)
    </ResponseField>

    <ResponseField name="activation_email_sent" type="boolean">
      Indica se o email de ativação foi enviado
    </ResponseField>

    <ResponseField name="referrer_count" type="number">
      Número total de indicações do usuário
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request POST \
    --url https://backend.testeswaffle.org/referrals/subscribe \
    --header 'Content-Type: application/json' \
    --data '{
      "referrer_id": "usr_123456789",
      "referred_email": "indicado@exemplo.com",
      "referred_name": "Carlos Indicado",
      "newsletter": "thenews",
      "campaign": "janeiro_2024"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "data": {
      "referral_id": "ref_987654321",
      "status": "pending",
      "activation_email_sent": true,
      "referrer_count": 5
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml POST /referrals/subscribe
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/subscribe:
    post:
      tags:
        - Public
      summary: Inscrever Indicação
      description: Inscreve um novo indicado na newsletter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - referrer_id
                - referred_email
              properties:
                referrer_id:
                  type: string
                  description: ID do usuário que está fazendo a indicação
                referred_email:
                  type: string
                  format: email
                  description: Email da pessoa sendo indicada
                campaign:
                  type: string
                  description: Nome da campanha de indicação
      responses:
        '200':
          description: Indicação criada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      referral_id:
                        type: string
                      status:
                        type: string
                      activation_email_sent:
                        type: boolean
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````