Skip to main content
POST
/
referrals
/
subscribe
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"
  }'

{
  "success": true,
  "data": {
    "referral_id": "ref_987654321",
    "status": "pending",
    "activation_email_sent": true,
    "referrer_count": 5
  }
}

​
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

​
referrer_id
string
required
ID do usuário que está fazendo a indicação
​
referred_email
string
required
Email da pessoa sendo indicada
​
referred_name
string
Nome da pessoa sendo indicada
​
newsletter
string
Newsletter para inscrição (padrão: thenews)
​
campaign
string
Nome da campanha de indicação para tracking

​
Response

​
success
boolean
Indica se a operação foi bem-sucedida
​
data
object
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"
  }'

{
  "success": true,
  "data": {
    "referral_id": "ref_987654321",
    "status": "pending",
    "activation_email_sent": true,
    "referrer_count": 5
  }
}

Body

application/json
​
referrer_id
string
required

ID do usuário que está fazendo a indicação

​
referred_email
string<email>
required

Email da pessoa sendo indicada

​
campaign
string

Nome da campanha de indicação

Response

200 - application/json

Indicação criada com sucesso

​
success
boolean
​
data
object