➕ Cadastro de Newsletter

📋 Descrição

Endpoint responsável por cadastrar um e-mail na lista de newsletter da loja.

Qualquer visitante pode se inscrever fornecendo apenas e-mail e nome. Não é necessário nenhum tipo de autenticação — o endpoint é completamente público.

Caso o e-mail informado já esteja cadastrado na newsletter, o endpoint retorna o registro existente sem criar duplicata.

Se o e-mail pertencer a um cliente já cadastrado na base de dados, o sistema ativa automaticamente as flags de e-mail e SMS promocional desse cliente (send_promotional_email e send_promotional_sms).

📝 Parâmetros

🏷️ Headers Obrigatórios

📦 Parâmetros do Corpo

💡 Exemplo de Requisição

1curl --request POST \
2  --url 'https://sua-loja-uappi.com.br/api/v3/customer/newsletter' \
3  --header 'Content-Type: application/json' \
4  --data '{
5    "email": "cliente@exemplo.com",
6    "name": "Maria Silva"
7  }'

✅ Resposta de Sucesso

HTTP Status: 201 Created

1{
2  "status": true,
3  "data": {
4    "id": 456,
5    "salesChannelId": 1,
6    "email": "cliente@exemplo.com",
7    "name": "Maria Silva",
8    "masked": false,
9    "createdAt": "2026-05-13 10:00:00"
10  }
11}

⚠️ Possíveis Erros

> Os cenários abaixo representam os principais erros que podem ocorrer neste endpoint, servindo como referência para entendimento e tratamento das falhas.