Skip to main content
POST
/
subscribe
curl --request POST \
  --url https://backend.testeswaffle.org/subscribe \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[email protected]",
    "name": "João Silva",
    "newsletter": "thenews",
    "source": "landing-page",
    "utm_source": "instagram",
    "utm_medium": "social",
    "utm_campaign": "janeiro_2024"
  }'

{
  "success": true,
  "message": "Dados atualizados com sucesso",
  "data": {
    "id": "sub_f8771aaf-6f76-46cb-a95a-bf524a617307",
    "email": "[email protected]",
    "status": "active",
    "created": 1730901809,
    "subscription_tier": "free",
    "subscription_premium_tier_names": [],
    "utm_source": "portal",
    "utm_medium": "",
    "utm_channel": "api",
    "utm_campaign": "",
    "referring_site": "https://thenews.waffle.com.br/",
    "referral_code": "Tq7Hsanmni",
    "stripe_customer_id": "",
    "custom_fields": [
      {
        "name": "[MKT][PI] Recap Mensal",
        "kind": "boolean",
        "value": true
      },
      {
        "name": "estados",
        "kind": "string",
        "value": "PI - Piauí"
      }
    ],
    "referral_id": "f6l55ycb03"
  }
}

​
Descrição

Inscreve um usuário diretamente em uma newsletter. Este endpoint é público e processa a inscrição imediatamente através da integração com Beehiiv.

​
Request Body

​
email
string
required
Email do usuário que deseja se inscrever
​
name
string
Nome completo do usuário
​
newsletter
string
required
ID da newsletter para inscrição. Valores aceitos:
  • thenews
  • thebizness
  • thestories
  • thejobs
  • thechamps
  • rising
  • goget ou GoGet
  • healthtimes
  • dollarbill
  • trendreport
​
source
string
Origem da inscrição (ex: landing-page, referral, social)
​
utm_source
string
Parâmetro UTM de origem
​
utm_medium
string
Parâmetro UTM de meio
​
utm_campaign
string
Parâmetro UTM de campanha

​
Response

​
success
boolean
Indica se a operação foi bem-sucedida
​
message
string
Mensagem de confirmação da operação
​
data
object
curl --request POST \
  --url https://backend.testeswaffle.org/subscribe \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[email protected]",
    "name": "João Silva",
    "newsletter": "thenews",
    "source": "landing-page",
    "utm_source": "instagram",
    "utm_medium": "social",
    "utm_campaign": "janeiro_2024"
  }'

{
  "success": true,
  "message": "Dados atualizados com sucesso",
  "data": {
    "id": "sub_f8771aaf-6f76-46cb-a95a-bf524a617307",
    "email": "[email protected]",
    "status": "active",
    "created": 1730901809,
    "subscription_tier": "free",
    "subscription_premium_tier_names": [],
    "utm_source": "portal",
    "utm_medium": "",
    "utm_channel": "api",
    "utm_campaign": "",
    "referring_site": "https://thenews.waffle.com.br/",
    "referral_code": "Tq7Hsanmni",
    "stripe_customer_id": "",
    "custom_fields": [
      {
        "name": "[MKT][PI] Recap Mensal",
        "kind": "boolean",
        "value": true
      },
      {
        "name": "estados",
        "kind": "string",
        "value": "PI - Piauí"
      }
    ],
    "referral_id": "f6l55ycb03"
  }
}

Body

application/json
​
email
string<email>
required

Email do usuário

​
newsletter
enum<string>
required

ID da newsletter

Available options:
thenews,
thebizness,
thechamps,
healthtimes,
rising,
goget,
podissovic
​
name
string

Nome completo do usuário

​
source
string

Origem da inscrição

​
utm_source
string

Parâmetro UTM de origem

​
utm_medium
string

Parâmetro UTM de meio

​
utm_campaign
string

Parâmetro UTM de campanha

Response

Inscrição realizada com sucesso

​
success
boolean
​
message
string
​
data
object